gradle/org.gradle.api.artifacts

Package-level declarations

Classes for declaring and using artifacts and artifact dependencies.

Types

ArtifactCollection

interface ArtifactCollection : Iterable<T>

A collection of artifacts resolved for a configuration.

ArtifactIdentifier

interface ~~ArtifactIdentifier~~

The identifier for a module artifact.

ArtifactRepositoryContainer

interface ArtifactRepositoryContainer : NamedDomainObjectList<T> , Configurable<T>

A ResolverContainer is responsible for managing a set of ArtifactRepository instances.

ArtifactSelectionDetails

interface ArtifactSelectionDetails

Details about artifact dependency substitution: this class gives access to the original dependency requested artifacts, if any, and gives the opportunity to replace the original requested artifacts with other artifacts.

ArtifactView

interface ArtifactView : HasAttributes

A view over the artifacts resolved for this set of dependencies.

CacheableRule

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = [ElementType.TYPE])

annotation class CacheableRule

Declares a rule eligible for caching.

CapabilitiesResolution

interface CapabilitiesResolution

Allows configuring the capabilities resolution strategy.

CapabilityResolutionDetails

interface CapabilityResolutionDetails

Gives access to the resolution details of a single capability conflict.

ClientModule

interface ~~ClientModule~~ : ExternalModuleDependency

To model a module in your dependency declarations.

ComponentMetadata

interface ComponentMetadata : HasAttributes

Provides a read-only view of a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM).

ComponentMetadataBuilder

interface ComponentMetadataBuilder

A component metadata builder.

ComponentMetadataContext

interface ComponentMetadataContext

Provides access to component metadata from a ComponentMetadataRule.

ComponentMetadataDetails

@NonExtensible

interface ComponentMetadataDetails : ComponentMetadata, HasConfigurableAttributes<SELF>

Describes a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM).

ComponentMetadataListerDetails

interface ComponentMetadataListerDetails

Allows a custom version lister to specify the list of versions known for a specific module.

ComponentMetadataRule

interface ComponentMetadataRule : Action<T>

A rule that modify component metadata.

ComponentMetadataSupplier

interface ComponentMetadataSupplier : Action<T>

A component metadata rule is responsible for providing the initial metadata of a component from a remote repository, in place of parsing the descriptor.

ComponentMetadataSupplierDetails

interface ComponentMetadataSupplierDetails

A component metadata rule details, giving access to the identifier of the component being resolved, the metadata builder, and the repository resource accessor for this.

ComponentMetadataVersionLister

interface ComponentMetadataVersionLister : Action<T>

Interface for custom version listers.

ComponentModuleMetadata

interface ComponentModuleMetadata

Contains immutable component module metadata information.

ComponentModuleMetadataDetails

interface ComponentModuleMetadataDetails : ComponentModuleMetadata

Contains and allows configuring component module metadata information.

ComponentSelection

interface ComponentSelection

Represents a tuple of the component selector of a module and a candidate version to be evaluated in a component selection rule.

ComponentSelectionRules

interface ComponentSelectionRules

Represents a container for component selection rules.

ComponentVariantIdentifier

interface ComponentVariantIdentifier

Identifies a variant of a component by component identifier and variant name.

ConfigurablePublishArtifact

interface ConfigurablePublishArtifact : PublishArtifact

A PublishArtifact whose properties can be modified.

Configuration

interface Configuration : FileCollection, HasConfigurableAttributes<SELF> , Named

A Configuration represents a group of artifacts and their dependencies.

ConfigurationContainer

@ServiceScope(value = Project::class)

interface ConfigurationContainer : NamedDomainObjectContainer<T>

A ConfigurationContainer is responsible for declaring and managing configurations.

ConfigurationPublications

interface ConfigurationPublications : HasConfigurableAttributes<SELF>

Represents the outgoing artifacts associated with a configuration.

ConfigurationVariant

interface ConfigurationVariant : Named, HasConfigurableAttributes<SELF>

Represents some variant of an outgoing configuration.

ConsumableConfiguration

@Incubating

interface ConsumableConfiguration : Configuration

A Configuration which can be consumed via Publishing and Dependency Management.

DependenciesMetadata

interface DependenciesMetadata<T : DependencyMetadata?> : Collection<E>

Describes metadata about a dependency - direct dependencies or dependency constraints - declared in a resolved component's metadata.

Dependency

interface Dependency

A Dependency represents a dependency on the artifacts from a particular source.

DependencyArtifact

interface DependencyArtifact

Data class that represents an artifact included in a org.gradle.api.artifacts.Dependency.

DependencyArtifactSelector

interface DependencyArtifactSelector

Details about an artifact selection in the context of a dependency substitution.

DependencyConstraint

interface DependencyConstraint : ModuleVersionSelector, HasConfigurableAttributes<SELF>

Represents a constraints over all, including transitive, dependencies.

DependencyConstraintMetadata

interface DependencyConstraintMetadata : DependencyMetadata<SELF>

Describes a dependency constraint declared in a resolved component's metadata, which typically originates from a component descriptor (Gradle metadata file).

DependencyConstraintSet

interface DependencyConstraintSet : DomainObjectSet<T>

A set of dependency constraint definitions that are associated with a configuration.

DependencyConstraintsMetadata

interface DependencyConstraintsMetadata : DependenciesMetadata<T>

Describes the dependency constraints of a variant declared in a resolved component's metadata, which typically originate from a component descriptor (Gradle metadata file).

DependencyMetadata

interface DependencyMetadata<SELF : DependencyMetadata?>

Describes a metadata about a dependency - direct dependency or dependency constraint - declared in a resolved component's metadata.

DependencyResolutionListener

interface DependencyResolutionListener

A DependencyResolutionListener is notified as dependencies are resolved.

DependencyResolveDetails

interface DependencyResolveDetails

Provides details about a dependency when it is resolved.

DependencyScopeConfiguration

@Incubating

interface DependencyScopeConfiguration : Configuration

A Configuration which collects dependencies, dependency constraints, and exclude rules.

DependencySet

interface DependencySet : DomainObjectSet<T> , Buildable

A set of artifact dependencies.

DependencySubstitution

interface DependencySubstitution

Provides means to substitute a different dependency during resolution.

DependencySubstitutions

interface DependencySubstitutions

Allows replacing dependencies with other dependencies.

DirectDependenciesMetadata

interface DirectDependenciesMetadata : DependenciesMetadata<T>

Describes the dependencies of a variant declared in a resolved component's metadata, which typically originate from a component descriptor (Gradle metadata file, Ivy file, Maven POM).

DirectDependencyMetadata

interface DirectDependencyMetadata : DependencyMetadata<SELF>

Describes a dependency declared in a resolved component's metadata, which typically originates from a component descriptor (Gradle metadata file, Ivy file, Maven POM).

ExcludeRule

interface ExcludeRule

An ExcludeRule is used to describe transitive dependencies that should be excluded when resolving dependencies.

ExcludeRuleContainer

interface ExcludeRuleContainer

A container for adding exclude rules for dependencies.

ExternalDependency

interface ExternalDependency : ModuleDependency, ModuleVersionSelector

An ExternalDependency is a Dependency on a source outside the current project hierarchy.

ExternalModuleDependency

interface ExternalModuleDependency : ExternalDependency

A ExternalModuleDependency is a Dependency on a module outside the current project hierarchy.