Configuration (Gradle API 2.2-20140924021627+0000)

すべてのスーパーインタフェース:

org.gradle.api.tasks.AntBuilderAware, Buildable, FileCollection, Iterable<File>
```
public interface Configuration
extends FileCollection
```
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

ネストされたクラスの概要

ネストされたクラス
修飾子とタイプ	インタフェースと説明
`static class`	`Configuration.Namer` A `Namer` namer for configurations that returns `getName()`.
`static class`	`Configuration.State` The states a configuration can be into.

インタフェースから継承されたネストされたクラス/インタフェース org.gradle.api.file.FileCollection
FileCollection.AntType

メソッドの概要

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`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 `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 `copyRecursive()`) but filtering the dependencies using the dependencySpec.
`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(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 `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()` 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.
`Configuration`	`setExtendsFrom(Iterable<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.

インタフェースから継承されたメソッド org.gradle.api.file.FileCollection
add, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsFileTree, getAsPath, getFiles, getSingleFile, isEmpty, minus, plus, stopExecutionIfEmpty

インタフェースから継承されたメソッド java.lang.Iterable
forEach, iterator, spliterator

- メソッドの詳細
  - getResolutionStrategy
```
ResolutionStrategy getResolutionStrategy()
```
    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.
    
    戻り値:
    
    resolution strategy
    
    導入されたバージョン:
    
    1.0-milestone-6
  - resolutionStrategy
```
Configuration resolutionStrategy(Closure closure)
```
    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 ResolutionStrategy
    
    戻り値:
    
    this configuration instance
    
    導入されたバージョン:
    
    1.0-milestone-6
  - getState
```
Configuration.State getState()
```
    Returns the state of the configuration.
    
    戻り値:
    
    The state of the configuration
    
    関連項目:
    
    Configuration.State
  - getName
```
String getName()
```
    Returns the name of this configuration.
    
    戻り値:
    
    The configuration name, never null.
  - isVisible
```
boolean isVisible()
```
    Returns true if this is a visible configuration. A visible configuration is usable outside the project it belongs to. The default value is true.
    
    戻り値:
    
    true if this is a visible configuration.
  - setVisible
```
Configuration setVisible(boolean visible)
```
    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
    
    戻り値:
    
    this configuration
  - getExtendsFrom
```
Set<Configuration> getExtendsFrom()
```
    Returns the names of the configurations which this configuration extends from. The artifacts of the super configurations are also available in this configuration.
    
    戻り値:
    
    The super configurations. Returns an empty set when this configuration does not extend any others.
  - setExtendsFrom
```
Configuration setExtendsFrom(Iterable<Configuration> superConfigs)
```
    Sets the configurations which this configuration extends from.
    
    パラメータ:
    
    superConfigs - The super configuration. Should not be null.
    
    戻り値:
    
    this configuration
  - extendsFrom
```
Configuration extendsFrom(Configuration... superConfigs)
```
    Adds the given configurations to the set of configuration which this configuration extends from.
    
    パラメータ:
    
    superConfigs - The super configurations.
    
    戻り値:
    
    this configuration
  - isTransitive
```
boolean isTransitive()
```
    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.
    
    戻り値:
    
    true if this is a transitive configuration, false otherwise.
  - setTransitive
```
Configuration setTransitive(boolean t)
```
    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.
    
    戻り値:
    
    this configuration
  - getDescription
```
String getDescription()
```
    Returns the description for this configuration.
    
    戻り値:
    
    the description. May be null.
  - setDescription
```
Configuration setDescription(String description)
```
    Sets the description for this configuration.
    
    パラメータ:
    
    description - the description. May be null
    
    戻り値:
    
    this configuration
  - getHierarchy
```
Set<Configuration> getHierarchy()
```
    Gets a ordered set including this configuration and all superconfigurations recursively.
    
    戻り値:
    
    the list of all configurations
  - resolve
```
Set<File> resolve()
```
    Resolves this configuration. This locates and downloads the files which make up this configuration, and returns the resulting set of files.
    
    戻り値:
    
    The files of this configuration.
  - files
```
Set<File> files(Closure dependencySpecClosure)
```
    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).
    
    戻り値:
    
    The files of a subset of dependencies of this configuration.
  - files
```
Set<File> files(Spec<? super Dependency> dependencySpec)
```
    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).
    
    戻り値:
    
    The files of a subset of dependencies of this configuration.
  - files
```
Set<File> files(Dependency... dependencies)
```
    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 resolved
    
    戻り値:
    
    The files of a subset of dependencies of this configuration.
  - fileCollection
```
FileCollection fileCollection(Spec<? super Dependency> dependencySpec)
```
    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).
    
    戻り値:
    
    The FileCollection with a subset of dependencies of this configuration.
  - fileCollection
```
FileCollection fileCollection(Closure dependencySpecClosure)
```
    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).
    
    戻り値:
    
    The FileCollection with a subset of dependencies of this configuration.
  - fileCollection
```
FileCollection fileCollection(Dependency... dependencies)
```
    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.
    
    戻り値:
    
    The FileCollection with a subset of dependencies of this configuration.
  - getResolvedConfiguration
```
ResolvedConfiguration getResolvedConfiguration()
```
    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).
    
    戻り値:
    
    The ResolvedConfiguration object
  - getUploadTaskName
```
String getUploadTaskName()
```
    Returns the name of the task that upload the artifacts of this configuration to repositories declared by the user.
    
    戻り値:
    
    The name of the associated upload task
    
    関連項目:
    
    Upload
  - getBuildDependencies
```
TaskDependency getBuildDependencies()
```
    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.
    
    定義:
    
    getBuildDependencies インタフェース内 Buildable
    
    戻り値:
    
    a TaskDependency object
  - getTaskDependencyFromProjectDependency
```
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.
    
    パラメータ:
    
    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
    
    戻り値:
    
    the populated TaskDependency object
  - getDependencies
```
DependencySet getDependencies()
```
    Gets the set of dependencies directly contained in this configuration (ignoring superconfigurations).
    
    戻り値:
    
    the set of dependencies
  - getAllDependencies
```
DependencySet getAllDependencies()
```
    Gets the complete set of dependencies including those contributed by superconfigurations.
    
    戻り値:
    
    the (read-only) set of dependencies
  - getArtifacts
```
PublishArtifactSet getArtifacts()
```
    Returns the artifacts of this configuration excluding the artifacts of extended configurations.
    
    戻り値:
    
    The set.
  - getAllArtifacts
```
PublishArtifactSet getAllArtifacts()
```
    Returns the artifacts of this configuration including the artifacts of extended configurations.
    
    戻り値:
    
    The (read-only) set.
  - getExcludeRules
```
Set<ExcludeRule> getExcludeRules()
```
    Returns the exclude rules applied for resolving any dependency of this configuration.
    
    戻り値:
    
    The exclude rules
    
    関連項目:
    
    exclude(java.util.Map)
  - exclude
```
Configuration exclude(Map<String,String> excludeProperties)
```
    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).
    
    パラメータ:
    
    excludeProperties - the properties to define the exclude rule.
    
    戻り値:
    
    this
  - getAll
```
Set<Configuration> getAll()
```
    Returns all the configurations belonging to the same configuration container as this configuration (including this configuration).
    
    戻り値:
    
    All of the configurations belong to the configuration container that this set belongs to.
  - getIncoming
```
ResolvableDependencies getIncoming()
```
    Returns the incoming dependencies of this configuration.
    
    戻り値:
    
    The incoming dependencies of this configuration. Never null.
  - copy
```
Configuration copy()
```
    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.
    
    戻り値:
    
    copy of this configuration
  - copyRecursive
```
Configuration copyRecursive()
```
    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. getHierarchy() for the copy will not include any superconfigurations.
    
    戻り値:
    
    copy of this configuration
  - copy
```
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.
    
    パラメータ:
    
    dependencySpec - filtering requirements
    
    戻り値:
    
    copy of this configuration
  - copyRecursive
```
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.
    
    パラメータ:
    
    dependencySpec - filtering requirements
    
    戻り値:
    
    copy of this configuration
  - copy
```
Configuration copy(Closure dependencySpec)
```
    Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as copy(org.gradle.api.specs.Spec)
    
    パラメータ:
    
    dependencySpec - filtering requirements
    
    戻り値:
    
    copy of this configuration
  - copyRecursive
```
Configuration copyRecursive(Closure dependencySpec)
```
    Takes a closure which gets coerced into a Spec. Behaves otherwise in the same way as copyRecursive(org.gradle.api.specs.Spec)
    
    パラメータ:
    
    dependencySpec - filtering requirements
    
    戻り値:
    
    copy of this configuration

インタフェース Configuration

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース org.gradle.api.file.FileCollection

メソッドの概要

インタフェースから継承されたメソッド org.gradle.api.file.FileCollection

インタフェースから継承されたメソッド java.lang.Iterable

メソッドの詳細

getResolutionStrategy

resolutionStrategy

getState

getName

isVisible

setVisible

getExtendsFrom

setExtendsFrom

extendsFrom

isTransitive

setTransitive

getDescription

setDescription

getHierarchy

resolve

files

files

files

fileCollection

fileCollection

fileCollection

getResolvedConfiguration

getUploadTaskName

getBuildDependencies

getTaskDependencyFromProjectDependency

getDependencies

getAllDependencies

getArtifacts

getAllArtifacts

getExcludeRules

exclude

getAll

getIncoming

copy

copyRecursive

copy

copyRecursive

copy

copyRecursive