org.gradle.api.internal.artifacts.configurations

Class DefaultConfiguration

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.artifacts.configurations.DefaultConfiguration

All Implemented Interfaces:

Iterable<File>, Configuration, Buildable, FileCollection, ConfigurationInternal, DependencyMetaDataProvider, MinimalFileCollection, MinimalFileSet, org.gradle.api.tasks.AntBuilderAware

public class DefaultConfiguration
extends AbstractFileCollection
implements ConfigurationInternal

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.artifacts.Configuration

Configuration.Namer, Configuration.State

Nested classes/interfaces inherited from interface org.gradle.api.file.FileCollection

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
DefaultConfiguration(String path, String name, ConfigurationsProvider configurationsProvider, ArtifactDependencyResolver dependencyResolver, ListenerManager listenerManager, DependencyMetaDataProvider metaDataProvider, DefaultResolutionStrategy resolutionStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	copy() Creates a copy of this configuration that only contains the dependencies directly in this configuration (without contributions from superconfigurations).
Configuration	copy(Closure dependencySpec) Takes a closure which gets coerced into a Spec.
Configuration	copy(Spec<? super Dependency> dependencySpec) Creates a copy of this configuration ignoring superconfigurations (see Configuration.copy() but filtering the dependencies using the specified dependency spec.
Configuration	copyRecursive() Creates a copy of this configuration that contains the dependencies directly in this configuration and those derived from superconfigurations.
Configuration	copyRecursive(Closure dependencySpec) Takes a closure which gets coerced into a Spec.
Configuration	copyRecursive(Spec<? super Dependency> dependencySpec) Creates a copy of this configuration with dependencies from superconfigurations (see Configuration.copyRecursive()) but filtering the dependencies using the dependencySpec.
String	dump() Print a formatted representation of a Configuration
DefaultConfiguration	exclude(Map<String,String> excludeRuleArgs) Adds an exclude rule to exclude transitive dependencies for all dependencies of this configuration.
Configuration	extendsFrom(Configuration... extendsFrom) Adds the given configurations to the set of configuration which this configuration extends from.
FileCollection	fileCollection(Closure dependencySpecClosure) Takes a closure which gets coerced into a Spec.
FileCollection	fileCollection(Dependency... dependencies) Resolves this configuration lazily.
FileCollection	fileCollection(Spec<? super Dependency> dependencySpec) Resolves this configuration lazily.
Set<File>	files(Closure dependencySpecClosure) Takes a closure which gets coerced into a Spec.
Set<File>	files(Dependency... dependencies) Resolves this configuration.
Set<File>	files(Spec<? super Dependency> dependencySpec) Resolves this configuration.
Set<Configuration>	getAll() Returns all the configurations belonging to the same configuration container as this configuration (including this configuration).
PublishArtifactSet	getAllArtifacts() Returns the artifacts of this configuration including the artifacts of extended configurations.
DependencySet	getAllDependencies() Gets the complete set of dependencies including those contributed by superconfigurations.
PublishArtifactSet	getArtifacts() Returns the artifacts of this configuration excluding the artifacts of extended configurations.
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
DependencySet	getDependencies() Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations).
DependencyResolutionListener	getDependencyResolutionBroadcast()
String	getDescription() Returns the description for this configuration.
String	getDisplayName() Returns the display name of this file collection.
Set<ExcludeRule>	getExcludeRules() Returns the exclude rules applied for resolving any dependency of this configuration.
Set<Configuration>	getExtendsFrom() Returns the names of the configurations which this configuration extends from.
Set<File>	getFiles() Returns the contents of this collection as a Set.
Set<Configuration>	getHierarchy() Gets a ordered set including this configuration and all superconfigurations recursively.
ResolvableDependencies	getIncoming() Returns the incoming dependencies of this configuration.
Module	getModule()
String	getName() Returns the name of this configuration.
DefaultResolutionStrategy	getResolutionStrategy() Returns the resolution strategy used by this configuration.
ResolvedConfiguration	getResolvedConfiguration() Resolves this configuration.
Configuration.State	getState() Returns the state of the configuration.
TaskDependency	getTaskDependencyFromProjectDependency(boolean useDependedOn, String taskName) 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.
String	getUploadTaskName() Returns the name of the task that upload the artifacts of this configuration to repositories declared by the user.
boolean	isTransitive() Returns the transitivity of this configuration.
boolean	isVisible() Returns true if this is a visible configuration.
Configuration	resolutionStrategy(Closure closure) The resolution strategy provides extra details on how to resolve this configuration.
Set<File>	resolve() Resolves this configuration.
Configuration	setDescription(String description) Sets the description for this configuration.
void	setExcludeRules(Set<ExcludeRule> excludeRules)
Configuration	setExtendsFrom(Set<Configuration> extendsFrom) Sets the configurations which this configuration extends from.
Configuration	setTransitive(boolean transitive) Sets the transitivity of this configuration.
Configuration	setVisible(boolean visible) Sets the visibility of this configuration.

Methods inherited from class org.gradle.api.internal.file.AbstractFileCollection

add, addAsFileSet, addAsMatchingTask, addAsResourceCollection, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsFileTree, getAsFileTrees, getAsPath, getCapDisplayName, getSingleFile, isEmpty, iterator, minus, plus, stopExecutionIfEmpty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gradle.api.file.FileCollection

add, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsFileTree, getAsPath, getSingleFile, isEmpty, minus, plus, stopExecutionIfEmpty

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

DefaultConfiguration

public DefaultConfiguration(String path,
                    String name,
                    ConfigurationsProvider configurationsProvider,
                    ArtifactDependencyResolver dependencyResolver,
                    ListenerManager listenerManager,
                    DependencyMetaDataProvider metaDataProvider,
                    DefaultResolutionStrategy resolutionStrategy)

Method Detail

getName

public String getName()

Description copied from interface: Configuration

Returns the name of this configuration.

Specified by:

getName in interface Configuration

Returns:

The configuration name, never null.

getState

public Configuration.State getState()

Description copied from interface: Configuration

Returns the state of the configuration.

Specified by:

getState in interface Configuration

Returns:

The state of the configuration

See Also:

Configuration.State

getModule

public Module getModule()

Specified by:

getModule in interface DependencyMetaDataProvider

isVisible

public boolean isVisible()

Description copied from interface: Configuration

Returns true if this is a visible configuration. A visible configuration is usable outside the project it belongs to. The default value is true.

Specified by:

isVisible in interface Configuration

Returns:

true if this is a visible configuration.

setVisible

public Configuration setVisible(boolean visible)

Description copied from interface: Configuration

Sets the visibility of this configuration. When visible is set to true, this configuration is visibile outside the project it belongs to. The default value is true.

Specified by:

setVisible in interface Configuration

Parameters:

visible - true if this is a visible configuration

Returns:

this configuration

getExtendsFrom

public Set<Configuration> getExtendsFrom()

Description copied from interface: Configuration

Returns the names of the configurations which this configuration extends from. The artifacts of the super configurations are also available in this configuration.

Specified by:

getExtendsFrom in interface Configuration

Returns:

The super configurations. Returns an empty set when this configuration does not extend any others.

setExtendsFrom

public Configuration setExtendsFrom(Set<Configuration> extendsFrom)

Description copied from interface: Configuration

Sets the configurations which this configuration extends from.

Specified by:

setExtendsFrom in interface Configuration

Parameters:

extendsFrom - The super configuration. Should not be null.

Returns:

this configuration

extendsFrom

public Configuration extendsFrom(Configuration... extendsFrom)

Description copied from interface: Configuration

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

Specified by:

extendsFrom in interface Configuration

Parameters:

extendsFrom - The super configurations.

Returns:

this configuration

isTransitive

public boolean isTransitive()

Description copied from interface: Configuration

Returns the transitivity of this configuration. A transitive configuration contains the transitive closure of its direct dependencies, and all their dependencies. An intransitive configuration contains only the direct dependencies. The default value is true.

Specified by:

isTransitive in interface Configuration

Returns:

true if this is a transitive configuration, false otherwise.

setTransitive

public Configuration setTransitive(boolean transitive)

Description copied from interface: Configuration

Sets the transitivity of this configuration. When set to true, this configuration will contain the transitive closure of its dependencies and their dependencies. The default value is true.

Specified by:

setTransitive in interface Configuration

Parameters:

transitive - true if this is a transitive configuration.

Returns:

this configuration

getDescription

public String getDescription()

Description copied from interface: Configuration

Returns the description for this configuration.

Specified by:

getDescription in interface Configuration

Returns:

the description. May be null.

setDescription

public Configuration setDescription(String description)

Description copied from interface: Configuration

Sets the description for this configuration.

Specified by:

setDescription in interface Configuration

Parameters:

description - the description. May be null

Returns:

this configuration

getHierarchy

public Set<Configuration> getHierarchy()

Description copied from interface: Configuration

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

Specified by:

getHierarchy in interface Configuration

Returns:

the list of all configurations

getAll

public Set<Configuration> getAll()

Description copied from interface: Configuration

Returns all the configurations belonging to the same configuration container as this configuration (including this configuration).

Specified by:

getAll in interface Configuration

Returns:

All of the configurations belong to the configuration container that this set belongs to.

resolve

public Set<File> resolve()

Description copied from interface: Configuration

Resolves this configuration. This locates and downloads the files which make up this configuration, and returns the resulting set of files.

Specified by:

resolve in interface Configuration

Returns:

The files of this configuration.

getFiles

public Set<File> getFiles()

Description copied from interface: FileCollection

Returns the contents of this collection as a Set.

Specified by:

getFiles in interface FileCollection

Specified by:

getFiles in interface MinimalFileSet

Returns:

The files. Returns an empty set if this collection is empty.

files

public Set<File> files(Dependency... dependencies)

Description copied from interface: Configuration

Resolves this configuration. This locates and downloads the files which make up this configuration. But only the resulting set of files belonging to the specified dependencies is returned.

Specified by:

files in interface Configuration

Parameters:

dependencies - The dependences to be resolved

Returns:

The files of a subset of dependencies of this configuration.

files

public Set<File> files(Closure dependencySpecClosure)

Description copied from interface: Configuration

Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as Configuration.files(org.gradle.api.specs.Spec).

Specified by:

files in interface Configuration

Parameters:

dependencySpecClosure - The closure describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).

Returns:

The files of a subset of dependencies of this configuration.

files

public Set<File> files(Spec<? super Dependency> dependencySpec)

Description copied from interface: Configuration

Resolves this configuration. This locates and downloads the files which make up this configuration. But only the resulting set of files belonging to the subset of dependencies specified by the dependencySpec is returned.

Specified by:

files in interface Configuration

Parameters:

dependencySpec - The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).

Returns:

The files of a subset of dependencies of this configuration.

fileCollection

public FileCollection fileCollection(Spec<? super Dependency> dependencySpec)

Description copied from interface: Configuration

Resolves this configuration lazily. The resolve happens when the elements of the returned FileCollection get accessed the first time. This locates and downloads the files which make up this configuration. Only the resulting set of files belonging to the subset of dependencies specified by the dependencySpec is contained in the FileCollection.

Specified by:

fileCollection in interface Configuration

Parameters:

dependencySpec - The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).

Returns:

The FileCollection with a subset of dependencies of this configuration.

fileCollection

public FileCollection fileCollection(Closure dependencySpecClosure)

Description copied from interface: Configuration

Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as Configuration.fileCollection(org.gradle.api.specs.Spec).

Specified by:

fileCollection in interface Configuration

Parameters:

dependencySpecClosure - The closure describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).

Returns:

The FileCollection with a subset of dependencies of this configuration.

fileCollection

public FileCollection fileCollection(Dependency... dependencies)

Description copied from interface: Configuration

Resolves this configuration lazily. The resolve happens when the elements of the returned FileCollection get accessed the first time. This locates and downloads the files which make up this configuration. Only the resulting set of files belonging to specified dependencies is contained in the FileCollection.

Specified by:

fileCollection in interface Configuration

Parameters:

dependencies - The dependencies for which the FileCollection should contain the files.

Returns:

The FileCollection with a subset of dependencies of this configuration.

getResolvedConfiguration

public ResolvedConfiguration getResolvedConfiguration()

Description copied from interface: Configuration

Resolves this configuration. This locates and downloads the files which make up this configuration, and returns a ResolvedConfiguration that may be used to determine information about the resolve (including errors).

Specified by:

getResolvedConfiguration in interface Configuration

Returns:

The ResolvedConfiguration object

getBuildDependencies

public TaskDependency getBuildDependencies()

Description copied from interface: Buildable

Returns a dependency which contains the tasks which build this artifact. All Buildable implementations must ensure that the returned dependency object is live, so that it tracks changes to the dependencies of this buildable.

Specified by:

getBuildDependencies in interface Configuration

Specified by:

getBuildDependencies in interface Buildable

Overrides:

getBuildDependencies in class AbstractFileCollection

Returns:

The dependency. Never returns null. Returns an empty dependency when this artifact is not built by any tasks.

getTaskDependencyFromProjectDependency

public TaskDependency getTaskDependencyFromProjectDependency(boolean useDependedOn,
                                                    String taskName)

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. These other projects may be projects this configuration depends on or projects with a similarly named configuration that depend on this one based on the useDependOn argument.

Specified by:

getTaskDependencyFromProjectDependency in interface Configuration

Parameters:

useDependedOn - if true, add tasks from project dependencies in this configuration, otherwise use projects from configurations with the same name that depend on this one.

taskName - name of task to depend on

Returns:

the populated TaskDependency object

getDependencies

public DependencySet getDependencies()

Description copied from interface: Configuration

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

Specified by:

getDependencies in interface Configuration

Returns:

the set of dependencies

getAllDependencies

public DependencySet getAllDependencies()

Description copied from interface: Configuration

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

Specified by:

getAllDependencies in interface Configuration

Returns:

the (read-only) set of dependencies

getArtifacts

public PublishArtifactSet getArtifacts()

Description copied from interface: Configuration

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

Specified by:

getArtifacts in interface Configuration

Returns:

The set.

getAllArtifacts

public PublishArtifactSet getAllArtifacts()

Description copied from interface: Configuration

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

Specified by:

getAllArtifacts in interface Configuration

Returns:

The (read-only) set.

getExcludeRules

public Set<ExcludeRule> getExcludeRules()

Description copied from interface: Configuration

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

Specified by:

getExcludeRules in interface Configuration

Returns:

The exclude rules

See Also:

Configuration.exclude(java.util.Map)

setExcludeRules

public void setExcludeRules(Set<ExcludeRule> excludeRules)

exclude

public DefaultConfiguration exclude(Map<String,String> excludeRuleArgs)

Description copied from interface: Configuration

Adds an exclude rule to exclude transitive dependencies for all dependencies of this configuration. You can also add exclude rules per-dependency. See ModuleDependency.exclude(java.util.Map).

Specified by:

exclude in interface Configuration

Parameters:

excludeRuleArgs - the properties to define the exclude rule.

Returns:

this

getUploadTaskName

public String getUploadTaskName()

Description copied from interface: Configuration

Returns the name of the task that upload the artifacts of this configuration to repositories declared by the user.

Specified by:

getUploadTaskName in interface Configuration

Returns:

The name of the associated upload task

See Also:

Upload

getDisplayName

public String getDisplayName()

Description copied from class: AbstractFileCollection

Returns the display name of this file collection. Used in log and error messages.

Specified by:

getDisplayName in interface MinimalFileCollection

Specified by:

getDisplayName in class AbstractFileCollection

Returns:

the display name

getIncoming

public ResolvableDependencies getIncoming()

Description copied from interface: Configuration

Returns the incoming dependencies of this configuration.

Specified by:

getIncoming in interface Configuration

Returns:

The incoming dependencies of this configuration. Never null.

copy

public Configuration copy()

Description copied from interface: Configuration

Creates a copy of this configuration that only contains the dependencies directly in this configuration (without contributions from superconfigurations). The new configuation will be in the UNRESOLVED state, but will retain all other attributes of this configuration except superconfigurations. Configuration.getHierarchy() for the copy will not include any superconfigurations.

Specified by:

copy in interface Configuration

Returns:

copy of this configuration

copyRecursive

public Configuration copyRecursive()

Description copied from interface: Configuration

Creates a copy of this configuration that contains the dependencies directly in this configuration and those derived from superconfigurations. The new configuration will be in the UNRESOLVED state, but will retain all other attributes of this configuration except superconfigurations. Configuration.getHierarchy() for the copy will not include any superconfigurations.

Specified by:

copyRecursive in interface Configuration

Returns:

copy of this configuration

copy

public Configuration copy(Spec<? super Dependency> dependencySpec)

Description copied from interface: Configuration

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

Specified by:

copy in interface Configuration

Parameters:

dependencySpec - filtering requirements

Returns:

copy of this configuration

copyRecursive

public Configuration copyRecursive(Spec<? super Dependency> dependencySpec)

Description copied from interface: Configuration

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

Specified by:

copyRecursive in interface Configuration

Parameters:

dependencySpec - filtering requirements

Returns:

copy of this configuration

copy

public Configuration copy(Closure dependencySpec)

Description copied from interface: Configuration

Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as Configuration.copy(org.gradle.api.specs.Spec)

Specified by:

copy in interface Configuration

Parameters:

dependencySpec - filtering requirements

Returns:

copy of this configuration

copyRecursive

public Configuration copyRecursive(Closure dependencySpec)

Description copied from interface: Configuration

Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as Configuration.copyRecursive(org.gradle.api.specs.Spec)

Specified by:

copyRecursive in interface Configuration

Parameters:

dependencySpec - filtering requirements

Returns:

copy of this configuration

getDependencyResolutionBroadcast

public DependencyResolutionListener getDependencyResolutionBroadcast()

Specified by:

getDependencyResolutionBroadcast in interface ConfigurationInternal

getResolutionStrategy

public DefaultResolutionStrategy getResolutionStrategy()

Description copied from interface: Configuration

Returns the resolution strategy used by this configuration. The resolution strategy provides extra details on how to resolve this configuration. See docs for ResolutionStrategy for more info and examples.

Specified by:

getResolutionStrategy in interface Configuration

Specified by:

getResolutionStrategy in interface ConfigurationInternal

Returns:

resolution strategy

resolutionStrategy

public Configuration resolutionStrategy(Closure closure)

Description copied from interface: Configuration

The resolution strategy provides extra details on how to resolve this configuration. See docs for ResolutionStrategy for more info and examples.

Specified by:

resolutionStrategy in interface Configuration

Parameters:

closure - closure applied to the ResolutionStrategy

Returns:

this configuration instance

dump

public String dump()

Print a formatted representation of a Configuration