|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Configuration
A Configuration
represents a group of artifacts and their dependencies.
Nested Class Summary | |
---|---|
static class |
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(groovy.lang.Closure dependencySpec)
Takes a closure which gets coerced into a Spec. |
|
Configuration |
copy(Spec<Dependency> dependencySpec)
Creates a copy of this configuration ignoring superconfigurations (see copy() but filtering
the dependencies using the dependencySpec. |
|
Configuration |
copyRecursive()
Creates a copy of this configuration that contains the dependencies directly in this configuration and those derived from superconfigurations. |
|
Configuration |
copyRecursive(groovy.lang.Closure dependencySpec)
Takes a closure which gets coerced into a Spec. |
|
Configuration |
copyRecursive(Spec<Dependency> dependencySpec)
Creates a copy of this configuration with dependencies from superconfigurations (see copyRecursive() )
but filtering the dependencies using the dependencySpec. |
|
Configuration |
exclude(java.util.Map<java.lang.String,java.lang.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(groovy.lang.Closure dependencySpecClosure)
Takes a closure which gets coerced into a Spec. |
|
FileCollection |
fileCollection(Dependency... dependencies)
Resolves this configuration lazyly. |
|
FileCollection |
fileCollection(Spec<Dependency> dependencySpec)
Resolves this configuration lazyly. |
|
java.util.Set<java.io.File> |
files(groovy.lang.Closure dependencySpecClosure)
Takes a closure which gets coerced into a Spec. |
|
java.util.Set<java.io.File> |
files(Dependency... dependencies)
Resolves this configuration. |
|
java.util.Set<java.io.File> |
files(Spec<Dependency> dependencySpec)
Resolves this configuration. |
|
java.util.Set<Configuration> |
getAll()
Returns all the configurations belonging to the same configuration container as this configuration (including this configuration). |
|
java.util.Set<PublishArtifact> |
getAllArtifacts()
Returns the artifacts of this configuration including the artifacts of extended configurations. |
|
java.util.Set<Dependency> |
getAllDependencies()
Gets the complete set of dependencies including those contributed by superconfigurations. |
|
|
getAllDependencies(java.lang.Class<T> type)
Gets the set of dependencies of type T for this configuration including thos contributed by superconfigurations. |
|
java.util.Set<PublishArtifact> |
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. |
|
java.util.Set<Dependency> |
getDependencies()
Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations). |
|
|
getDependencies(java.lang.Class<T> 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. |
|
java.util.Set<ExcludeRule> |
getExcludeRules()
Returns the exclude rules applied for resolving any dependency of this configuration. |
|
java.util.Set<Configuration> |
getExtendsFrom()
Returns the names of the configurations which this configuration extends from. |
|
java.util.List<Configuration> |
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. |
|
Configuration.State |
getState()
Returns the state of the configuration. |
|
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(java.util.List<org.apache.ivy.plugins.resolver.DependencyResolver> publishRepositories,
PublishInstruction publishInstruction)
Publishes the artifacts of this configuration to the specified repositories. |
|
java.util.Set<java.io.File> |
resolve()
Resolves this configuration. |
|
Configuration |
setDescription(java.lang.String description)
Sets the description for this configuration. |
|
Configuration |
setExtendsFrom(java.util.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 interface org.gradle.api.artifacts.FileCollection |
---|
getAsPath, getFiles, getSingleFile, plus |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Method Detail |
---|
Configuration.State getState()
Configuration.State
java.lang.String getName()
boolean isVisible()
Configuration setVisible(boolean visible)
visible
- true if this is a visible configuration
java.util.Set<Configuration> getExtendsFrom()
Configuration setExtendsFrom(java.util.Set<Configuration> superConfigs)
superConfigs
- The super configuration. Should not be null.
Configuration extendsFrom(Configuration... superConfigs)
superConfigs
- The super configurations.
boolean isTransitive()
Configuration setTransitive(boolean t)
t
- true if this is a transitive configuration.
java.lang.String getDescription()
Configuration setDescription(java.lang.String description)
description
- the description. May be null
java.util.List<Configuration> getHierarchy()
java.util.Set<java.io.File> resolve()
java.util.Set<java.io.File> files(groovy.lang.Closure dependencySpecClosure)
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).
java.util.Set<java.io.File> files(Spec<Dependency> dependencySpec)
dependencySpec
- The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).
java.util.Set<java.io.File> files(Dependency... dependencies)
dependencies
- The dependences to be resolved
FileCollection fileCollection(Spec<Dependency> dependencySpec)
dependencySpec
- The spec describing a filter applied to the all the dependencies of this configuration (including dependencies from extended configurations).
FileCollection fileCollection(groovy.lang.Closure dependencySpecClosure)
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).
FileCollection fileCollection(Dependency... dependencies)
dependencies
- The dependencies for which the FileCollection should contain the files.
ResolvedConfiguration getResolvedConfiguration()
java.lang.String getUploadInternalTaskName()
java.lang.String getUploadTaskName()
Upload
TaskDependency getBuildDependencies()
TaskDependency getBuildArtifacts()
void publish(java.util.List<org.apache.ivy.plugins.resolver.DependencyResolver> publishRepositories, PublishInstruction publishInstruction)
publishRepositories
- The repositories to publish the artifacts to.publishInstruction
- Instructions for details of the upload.Upload
,
getUploadTaskName()
java.util.Set<Dependency> getDependencies()
java.util.Set<Dependency> getAllDependencies()
<T extends Dependency> java.util.Set<T> getDependencies(java.lang.Class<T> type)
T
- the dependency typetype
- the dependency type
<T extends Dependency> java.util.Set<T> getAllDependencies(java.lang.Class<T> type)
T
- the dependency typetype
- the dependency type
void addDependency(Dependency dependency)
dependency
- The dependency to be added.java.util.Set<PublishArtifact> getArtifacts()
java.util.Set<PublishArtifact> getAllArtifacts()
java.util.Set<ExcludeRule> getExcludeRules()
exclude(java.util.Map)
Configuration exclude(java.util.Map<java.lang.String,java.lang.String> excludeProperties)
ModuleDependency.exclude(java.util.Map)
.
excludeProperties
- the properties to define the exclude rule.
java.util.Set<Configuration> getAll()
Configuration addArtifact(PublishArtifact artifact)
artifact
- The artifact.
Configuration copy()
getHierarchy()
for the copy will not include any superconfigurations.
Configuration copyRecursive()
getHierarchy()
for the copy will not include any superconfigurations.
Configuration copy(Spec<Dependency> dependencySpec)
copy()
but filtering
the dependencies using the dependencySpec. The dependencySpec may be obtained from
DependencySpecs.type()
like
DependencySpecs.type(Type.EXTERNAL)
dependencySpec
- filtering requirements
Configuration copyRecursive(Spec<Dependency> dependencySpec)
copyRecursive()
)
but filtering the dependencies using the dependencySpec. The dependencySpec may be obtained from
DependencySpecs.type()
like
DependencySpecs.type(Type.EXTERNAL)
dependencySpec
- filtering requirements
Configuration copy(groovy.lang.Closure dependencySpec)
copy(org.gradle.api.specs.Spec)
dependencySpec
- filtering requirements
Configuration copyRecursive(groovy.lang.Closure dependencySpec)
copyRecursive(org.gradle.api.specs.Spec)
dependencySpec
- filtering requirements
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |