gradle/org.gradle.api.artifacts/Configuration

Configuration

interface Configuration : FileCollection, HasConfigurableAttributes<Configuration> , Named(source)

A Configuration represents a group of artifacts and their dependencies. Find more information about declaring dependencies to a configuration or about managing configurations in docs for ConfigurationContainer

Configuration is an instance of a FileCollection that contains all dependencies (see also getAllDependencies) but not artifacts. If you want to refer to the artifacts declared in this configuration please use getArtifacts or getAllArtifacts. Read more about declaring artifacts in the configuration in docs for org.gradle.api.artifacts.dsl.ArtifactHandler Please see the Declaring Dependencies User Manual chapter for more information.

Inheritors

ConsumableConfiguration

ResolvableConfiguration

DependencyScopeConfiguration

LegacyConfiguration

Types

State

enum State

The states a configuration can be into.

Functions

addToAntBuilder

abstract fun addToAntBuilder(builder: Any, nodeName: String): Any

abstract fun addToAntBuilder(builder: Any, nodeName: String, type: FileCollection.AntType)

Adds this collection to an Ant task as a nested node.

abstract fun addToAntBuilder(node: Any, childNodeName: String): Any

attributes

abstract fun attributes(action: Action<in AttributeContainer>): SELF

Configure the attribute container that provides the attributes associated with this domain object.

contains

abstract fun contains(file: File): Boolean

Determines whether this collection contains the given file.

copy

abstract fun copy(): Configuration

Creates a copy of this configuration that only contains the dependencies directly in this configuration (without contributions from superconfigurations).

abstract fun copy(dependencySpec: Closure): Configuration

Takes a closure which gets coerced into a Spec.

abstract fun copy(dependencySpec: Spec<in Dependency>): Configuration

Creates a copy of this configuration ignoring superconfigurations (see copy but filtering the dependencies using the specified dependency spec.

copyRecursive

abstract fun copyRecursive(): Configuration

Creates a copy of this configuration that contains the dependencies directly in this configuration and those derived from superconfigurations.

abstract fun copyRecursive(dependencySpec: Closure): Configuration

Takes a closure which gets coerced into a Spec.

abstract fun copyRecursive(dependencySpec: Spec<in Dependency>): Configuration

Creates a copy of this configuration with dependencies from superconfigurations (see copyRecursive) but filtering the dependencies using the dependencySpec.

defaultDependencies

abstract fun defaultDependencies(action: Action<in DependencySet>): Configuration

Execute the given action if the configuration has no defined dependencies when it first participates in dependency resolution.

disableConsistentResolution

@Incubating

abstract fun disableConsistentResolution(): Configuration

Disables consistent resolution for this configuration.

exclude

abstract fun exclude(excludeProperties: Map<String, String>): Configuration

Adds an exclude rule to exclude transitive dependencies for all dependencies of this configuration.

extendsFrom

abstract fun extendsFrom(superConfigs: Array<Configuration>): Configuration

@Incubating

abstract fun extendsFrom(superConfigs: Array<Provider<out Configuration>>): Configuration

Adds the given configurations to the set of configuration which this configuration extends from.

filter

abstract fun filter(filterClosure: Closure): FileCollection

abstract fun filter(filterSpec: Spec<in File>): FileCollection

Restricts the contents of this collection to those files which match the given criteria.

forEach

open fun forEach(action: Consumer<in T>)

fromDependencyCollector

@Incubating

open fun fromDependencyCollector(collector: DependencyCollector)

Use the given collector as a source for dependencies and dependency constraints.

getAllArtifacts

abstract fun getAllArtifacts(): PublishArtifactSet

Returns the artifacts of this configuration including the artifacts of extended configurations.

getAllDependencies

abstract fun getAllDependencies(): DependencySet

Gets the complete set of declared dependencies including those contributed by superconfigurations.

getAllDependencyConstraints

abstract fun getAllDependencyConstraints(): DependencyConstraintSet

Gets the complete set of dependency constraints including those contributed by superconfigurations.

getArtifacts

abstract fun getArtifacts(): PublishArtifactSet

Returns the artifacts of this configuration excluding the artifacts of extended configurations.

getAsFileTree

abstract fun getAsFileTree(): FileTree

Converts this collection to a FileTree, if not already.

getAsPath

abstract fun getAsPath(): String

Returns the contents of this collection as a platform-specific path.

getAttributes

abstract fun getAttributes(): AttributeContainer

Returns the attributes

getBuildDependencies

abstract fun getBuildDependencies(): TaskDependency

Returns a TaskDependency object containing all required dependencies to build the local dependencies (e.g.

getDependencies

abstract fun getDependencies(): DependencySet

Gets the set of declared dependencies directly contained in this configuration (ignoring superconfigurations).

getDependencyConstraints

abstract fun getDependencyConstraints(): DependencyConstraintSet

Gets the set of dependency constraints directly contained in this configuration (ignoring superconfigurations).

getDescription

@Nullable

abstract fun getDescription(): @Nullable String

Returns the description for this configuration.

getElements

abstract fun getElements(): Provider<Set<FileSystemLocation>>

Returns the contents of this file collection as a Provider of FileSystemLocation instances.

getExcludeRules

abstract fun getExcludeRules(): Set<ExcludeRule>

Returns the exclude rules applied for resolving any dependency of this configuration.

getExtendsFrom

abstract fun getExtendsFrom(): Set<Configuration>

Returns the configurations which this configuration extends from.

getFiles

abstract fun getFiles(): Set<File>

Returns the contents of this collection as a Set.

getHierarchy

abstract fun getHierarchy(): Set<Configuration>

Gets an ordered set including this configuration and all superconfigurations recursively.

getIncoming

abstract fun getIncoming(): ResolvableDependencies

Returns a ResolvableDependencies instance, exposing the results of dependency resolution.

getName

abstract fun getName(): String

The object's name.

getOutgoing

abstract fun getOutgoing(): ConfigurationPublications

Returns the outgoing ConfigurationPublications instance that advertises and allows configuring the artifacts and variants published by this configuration.

getResolutionStrategy

abstract fun getResolutionStrategy(): ResolutionStrategy

Returns the resolution strategy used by this configuration.

getResolvedConfiguration

abstract fun getResolvedConfiguration(): ResolvedConfiguration

Returns a ResolvedConfiguration, a legacy view of the results of dependency resolution.

getSingleFile

abstract fun getSingleFile(): File

Returns the content of this collection, asserting it contains exactly one file.

getState

abstract fun getState(): Configuration.State

Returns the state of the configuration.

getTaskDependencyFromProjectDependency

abstract fun getTaskDependencyFromProjectDependency(useDependedOn: Boolean, taskName: String): TaskDependency

Returns a TaskDependency object containing dependencies on all tasks with the specified name from project dependencies related to this configuration or one of its super configurations.

isCanBeConsumed

abstract fun isCanBeConsumed(): Boolean

Returns true if this configuration can be consumed from another project, or published.

isCanBeDeclared

@Incubating

abstract fun isCanBeDeclared(): Boolean

Returns true if it is allowed to declare dependencies upon this configuration.

isCanBeResolved

abstract fun isCanBeResolved(): Boolean

Returns true if it is allowed to query or resolve this configuration.

isEmpty

abstract fun isEmpty(): Boolean

Returns true if this collection is empty.

isTransitive

abstract fun isTransitive(): Boolean

Returns the transitivity of this configuration.

isVisible

abstract fun ~~isVisible~~(): Boolean

This is a legacy property and the value does not affect dependency resolution in any way.

iterator

abstract fun iterator(): Iterator<T>

minus

abstract fun minus(collection: FileCollection): FileCollection

Returns a FileCollection which contains the difference between this collection and the given collection.

outgoing

abstract fun outgoing(action: Action<in ConfigurationPublications>)

Configures the outgoing ConfigurationPublications instance that advertises and allows configuring the artifacts and variants published by this configuration.

plus

abstract fun plus(collection: FileCollection): FileCollection

Returns a FileCollection which contains the union of this collection and the given collection.

resolutionStrategy

abstract fun resolutionStrategy(@DelegatesTo(value = ResolutionStrategy::class, strategy = 1) closure: Closure): Configuration

abstract fun resolutionStrategy(action: Action<in ResolutionStrategy>): Configuration

The resolution strategy provides extra details on how to resolve this configuration.

resolve

abstract fun resolve(): Set<File>

Resolves this configuration.

setCanBeConsumed

abstract fun setCanBeConsumed(allowed: Boolean)

Configures if a configuration can be consumed.

setCanBeDeclared

@Incubating

abstract fun setCanBeDeclared(allowed: Boolean)

Configures if a configuration can have dependencies declared upon it.

setCanBeResolved

abstract fun setCanBeResolved(allowed: Boolean)

Configures if a configuration can be resolved.

setDescription

abstract fun setDescription(@Nullable description: @Nullable String): Configuration

Sets the description for this configuration.

setExtendsFrom

abstract fun setExtendsFrom(superConfigs: Iterable<Configuration>): Configuration

Sets the configurations which this configuration extends from.

setTransitive

abstract fun setTransitive(t: Boolean): Configuration

Sets the transitivity of this configuration.

setVisible

abstract fun ~~setVisible~~(visible: Boolean): Configuration

Sets the value returned by isVisible.

shouldResolveConsistentlyWith

@Incubating

abstract fun shouldResolveConsistentlyWith(versionsSource: Configuration): Configuration

Tells that this configuration, when resolved, should resolve versions consistently from the resolution result of another resolvable configuration.

spliterator

open fun spliterator(): Spliterator<T>

withDependencies

abstract fun withDependencies(action: Action<in DependencySet>): Configuration

Execute the given action before the configuration first participates in dependency resolution.