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 ArtifactHandler
Modifiers | Name | Description |
---|---|---|
static class |
Configuration.Namer |
A Namer namer for configurations that returns getName(). |
enum |
Configuration.State |
The states a configuration can be into. |
Type | Name 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(Spec<? super Dependency> dependencySpec) Creates a copy of this configuration ignoring superconfigurations (see copy() but filtering the dependencies using the specified dependency spec. |
Configuration |
copy(Closure dependencySpec) Takes a closure which gets coerced into a Spec. |
Configuration |
copyRecursive() Creates a copy of this configuration that contains the dependencies directly in this configuration and those derived from superconfigurations. |
Configuration |
copyRecursive(Spec<? super Dependency> dependencySpec) Creates a copy of this configuration with dependencies from superconfigurations (see copyRecursive()) but filtering the dependencies using the dependencySpec. |
Configuration |
copyRecursive(Closure dependencySpec) Takes a closure which gets coerced into a Spec. |
Configuration |
exclude(Map<String, String> excludeProperties) Adds an exclude rule to exclude transitive dependencies for all dependencies of this configuration. |
Configuration |
extendsFrom(Configuration... superConfigs) Adds the given configurations to the set of configuration which this configuration extends from. |
FileCollection |
fileCollection(Spec<? super Dependency> dependencySpec) Resolves this configuration lazily. |
FileCollection |
fileCollection(Closure dependencySpecClosure) Takes a closure which gets coerced into a Spec. |
FileCollection |
fileCollection(Dependency... dependencies) Resolves this configuration lazily. |
Set<File> |
files(Closure dependencySpecClosure) Takes a closure which gets coerced into a Spec. |
Set<File> |
files(Spec<? super Dependency> dependencySpec) Resolves this configuration. |
Set<File> |
files(Dependency... dependencies) 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() |
PublishArtifactSet |
getArtifacts() Returns the artifacts of this configuration excluding the artifacts of extended configurations. |
TaskDependency |
getBuildDependencies() Returns a TaskDependency object containing all required dependencies to build the internal dependencies
(e.g.
|
DependencySet |
getDependencies() Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations). |
String |
getDescription() Returns the description for this configuration. |
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<Configuration> |
getHierarchy() Gets a ordered set including this configuration and all superconfigurations recursively. |
ResolvableDependencies |
getIncoming() Returns the incoming dependencies of this configuration. |
String |
getName() Returns the name of this configuration. |
ResolutionStrategy |
getResolutionStrategy() Returns the resolution strategy used by this configuration. |
ResolvedConfiguration |
getResolvedConfiguration() Resolves this configuration. |
Configuration.State |
getState() A Configuration represents a group of artifacts and their dependencies.
|
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. |
Configuration |
setExtendsFrom(Set<Configuration> superConfigs) Sets the configurations which this configuration extends from. |
Configuration |
setTransitive(boolean t) Sets the transitivity of this configuration. |
Configuration |
setVisible(boolean visible) Sets the visibility of this configuration. |
Methods inherited from class | Name |
---|---|
interface FileCollection |
add, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsFileTree, getAsPath, getFiles, getSingleFile, isEmpty, minus, plus, stopExecutionIfEmpty |
interface Buildable |
getBuildDependencies |
interface Iterable |
iterator |
interface AntBuilderAware |
addToAntBuilder |
Creates a copy of this configuration that only contains the dependencies directly in this configuration (without contributions from superconfigurations). The new configuration will be in the UNRESOLVED state, but will retain all other attributes of this configuration except superconfigurations. getHierarchy() for the copy will not include any superconfigurations.
Creates a copy of this configuration ignoring superconfigurations (see copy() but filtering the dependencies using the specified dependency spec.
dependencySpec
- filtering requirementsTakes a closure which gets coerced into a Spec. Behaves otherwise in the same way as copy(org.gradle.api.specs.Spec)
dependencySpec
- filtering requirementsCreates 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. getHierarchy() for the copy will not include any superconfigurations.
Creates a copy of this configuration with dependencies from superconfigurations (see copyRecursive()) but filtering the dependencies using the dependencySpec.
dependencySpec
- filtering requirementsTakes a closure which gets coerced into a Spec. Behaves otherwise in the same way as copyRecursive(org.gradle.api.specs.Spec)
dependencySpec
- filtering requirementsAdds an exclude rule to exclude transitive dependencies for all dependencies of this configuration. You can also add exclude rules per-dependency. See ModuleDependency.exclude.
excludeProperties
- the properties to define the exclude rule.Adds the given configurations to the set of configuration which this configuration extends from.
superConfigs
- The super configurations.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.
dependencySpec
- The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as fileCollection(org.gradle.api.specs.Spec).
dependencySpecClosure
- The closure describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).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.
dependencies
- The dependencies for which the FileCollection should contain the files.Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as files(org.gradle.api.specs.Spec).
dependencySpecClosure
- The closure describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).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.
dependencySpec
- The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).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.
dependencies
- The dependences to be resolvedReturns all the configurations belonging to the same configuration container as this configuration (including this configuration).
Returns the artifacts of this configuration including the artifacts of extended configurations.
Gets the complete set of dependencies including those contributed by superconfigurations.
Returns the artifacts of this configuration excluding the artifacts of extended configurations.
Returns a TaskDependency
object containing all required dependencies to build the internal dependencies
(e.g. project dependencies) belonging to this configuration or to one of its super configurations.
Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations).
Returns the description for this configuration.
Returns the exclude rules applied for resolving any dependency of this configuration.
Returns the names of the configurations which this configuration extends from. The artifacts of the super configurations are also available in this configuration.
Gets a ordered set including this configuration and all superconfigurations recursively.
Returns the incoming dependencies of this configuration.
null
.Returns the name of this 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.
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).
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 ArtifactHandler
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.
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 onReturns the name of the task that upload the artifacts of this configuration to repositories declared by the user.
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.
Returns true if this is a visible configuration. A visible configuration is usable outside the project it belongs to. The default value is true.
The resolution strategy provides extra details on how to resolve this configuration. See docs for ResolutionStrategy for more info and examples.
closure
- closure applied to the ResolutionStrategyResolves this configuration. This locates and downloads the files which make up this configuration, and returns the resulting set of files.
Sets the description for this configuration.
description
- the description. May be nullSets the configurations which this configuration extends from.
superConfigs
- The super configuration. Should not be null.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.
t
- true if this is a transitive 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.
visible
- true if this is a visible configuration