|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
org.gradle.api.artifacts.Configurationorg.gradle.api.artifacts.FileCollection
interface Configuration extends FileCollection
A Configuration represents a group of artifacts and their dependencies.
Nested Class Summary | |
---|---|
enum |
Configuration.State
The states a configuration can be into. |
Method Summary | |
---|---|
Configuration
|
addArtifact(PublishArtifact artifact)
Adds an artifact to be published to this configuration. |
void
|
addDependency(Dependency dependency)
Adds a dependency to this configuration |
Configuration
|
copy()
Creates a copy of this configuration that only contains the dependencies directly in this configuration (without contributions from superconfigurations). |
Configuration
|
copy(Spec dependencySpec)
Creates a copy of this configuration ignoring superconfigurations (see { the dependencies using the dependencySpec. |
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 dependencySpec)
Creates a copy of this configuration with dependencies from superconfigurations (see { but filtering the dependencies using the dependencySpec. |
Configuration
|
copyRecursive(Closure dependencySpec)
Takes a closure which gets coerced into a Spec. |
Configuration
|
exclude(Map 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 dependencySpec)
Resolves this configuration lazyly. |
FileCollection
|
fileCollection(Closure dependencySpecClosure)
Takes a closure which gets coerced into a Spec. |
FileCollection
|
fileCollection(Dependency dependencies)
Resolves this configuration lazyly. |
Set
|
files(Closure dependencySpecClosure)
Takes a closure which gets coerced into a Spec. |
Set
|
files(Spec dependencySpec)
Resolves this configuration. |
Set
|
files(Dependency dependencies)
Resolves this configuration. |
Set
|
getAll()
Returns all the configurations belonging to the same configuration container as this configuration (including this configuration). |
Set
|
getAllArtifacts()
Returns the artifacts of this configuration including the artifacts of extended configurations. |
Set
|
getAllDependencies()
Gets the complete set of dependencies including those contributed by superconfigurations. |
Set
|
getAllDependencies(java.lang.Class type)
Gets the set of dependencies of type T for this configuration including thos contributed by superconfigurations. |
Set
|
getArtifacts()
Returns the artifacts of this configuration excluding the artifacts of extended configurations. |
TaskDependency
|
getBuildArtifacts()
Returns a task dependencies object containing all required dependencies to build the artifacts belonging to this configuration or to one of its super configurations. |
TaskDependency
|
getBuildDependencies()
Returns a task dependencies 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. |
Set
|
getDependencies()
Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations). |
Set
|
getDependencies(java.lang.Class type)
Gets the set of dependencies of type T directly contained in this configuration (ignoring superconfigurations). |
java.lang.String
|
getDescription()
Returns the description for this configuration. |
Set
|
getExcludeRules()
Returns the exclude rules applied for resolving any dependency of this configuration. |
Set
|
getExtendsFrom()
Returns the names of the configurations which this configuration extends from. |
List
|
getHierarchy()
Gets a list including this configuration and all superconfigurations recursively. |
java.lang.String
|
getName()
Returns the name of this configuration. |
ResolvedConfiguration
|
getResolvedConfiguration()
Resolves this configuration. |
State
|
getState()
A { |
java.lang.String
|
getUploadInternalTaskName()
Returns the name of the task that upload the artifacts of this configuration to the internal Gradle repository used resolving inter-project dependencies. |
java.lang.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. |
void
|
publish(List publishRepositories, PublishInstruction publishInstruction)
Publishes the artifacts of this configuration to the specified repositories. |
Set
|
resolve()
Resolves this configuration. |
Configuration
|
setDescription(java.lang.String description)
Sets the description for this configuration. |
Configuration
|
setExtendsFrom(Set 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. |
Configuration
|
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
org.gradle.api.artifacts.Configuration[]
|
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from interface FileCollection | |
---|---|
getAsPath, getFiles, getSingleFile, plus |
Methods inherited from interface java.lang.Iterable | |
---|---|
iterator |
Methods inherited from class java.lang.Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll |
Method Detail |
---|
public Configuration addArtifact(PublishArtifact artifact)
public void addDependency(Dependency dependency)
public Configuration copy()
public Configuration copy(Spec dependencySpec)
public Configuration copy(Closure dependencySpec)
public Configuration copyRecursive()
public Configuration copyRecursive(Spec dependencySpec)
public Configuration copyRecursive(Closure dependencySpec)
public Configuration exclude(Map excludeProperties)
public Configuration extendsFrom(Configuration superConfigs)
public FileCollection fileCollection(Spec dependencySpec)
public FileCollection fileCollection(Closure dependencySpecClosure)
public FileCollection fileCollection(Dependency dependencies)
public Set files(Closure dependencySpecClosure)
public Set files(Spec dependencySpec)
public Set files(Dependency dependencies)
public Set getAll()
public Set getAllArtifacts()
public Set getAllDependencies()
public Set getAllDependencies(java.lang.Class type)
public Set getArtifacts()
public TaskDependency getBuildArtifacts()
public TaskDependency getBuildDependencies()
public Set getDependencies()
public Set getDependencies(java.lang.Class type)
public java.lang.String getDescription()
public Set getExcludeRules()
public Set getExtendsFrom()
public List getHierarchy()
public java.lang.String getName()
public ResolvedConfiguration getResolvedConfiguration()
public State getState()
A Configuration represents a group of artifacts and their dependencies.
public java.lang.String getUploadInternalTaskName()
public java.lang.String getUploadTaskName()
public boolean isTransitive()
public boolean isVisible()
public void publish(List publishRepositories, PublishInstruction publishInstruction)
public Set resolve()
public Configuration setDescription(java.lang.String description)
public Configuration setExtendsFrom(Set superConfigs)
public Configuration setTransitive(boolean t)
public Configuration setVisible(boolean visible)
Configuration valueOf(java.lang.String name)
org.gradle.api.artifacts.Configuration[] values()
Groovy Documentation