org.gradle.api.internal.artifacts.configurations

Class DefaultConfigurationContainer

java.lang.Object

java.util.AbstractCollection<T>

org.gradle.api.internal.DefaultDomainObjectCollection<T>

org.gradle.api.internal.DefaultNamedDomainObjectCollection<T>

org.gradle.api.internal.DefaultNamedDomainObjectSet<T>

org.gradle.api.internal.AbstractNamedDomainObjectContainer<Configuration>

org.gradle.api.internal.artifacts.configurations.DefaultConfigurationContainer

All Implemented Interfaces:

Iterable<Configuration>, Collection<Configuration>, Set<Configuration>, ConfigurationContainer, DomainObjectCollection<Configuration>, ConfigurationContainerInternal, ConfigurationsProvider, DynamicObjectAware, NamedDomainObjectCollection<Configuration>, NamedDomainObjectContainer<Configuration>, NamedDomainObjectSet<Configuration>, Configurable<NamedDomainObjectContainer<Configuration>>

public class DefaultConfigurationContainer
extends AbstractNamedDomainObjectContainer<Configuration>
implements ConfigurationContainerInternal, ConfigurationsProvider

Author:

Hans Dockter

Field Summary

Fields

Modifier and Type	Field and Description
static String	DETACHED_CONFIGURATION_DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationContainer(ArtifactDependencyResolver dependencyResolver, Instantiator instantiator, DomainObjectContext context, ListenerManager listenerManager, DependencyMetaDataProvider dependencyMetaDataProvider)

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	add(String name) Adds a configuration with the given name.
Configuration	add(String name, Closure closure) Adds a configuration with the given name.
protected UnknownDomainObjectException	createNotFoundException(String name)
Configuration	detachedConfiguration(Dependency... dependencies) Creates a configuration, but does not add it to this container.
protected Configuration	doCreate(String name) Subclasses need only implement this method as the creation strategy.
String	dump() Build a formatted representation of all Configurations in this ConfigurationContainer.
Set<Configuration>	getAll()
ConfigurationInternal	getByName(String name) Locates an object by name, failing if there is no such object.
String	getTypeDisplayName()

Methods inherited from class org.gradle.api.internal.AbstractNamedDomainObjectContainer

configure, create, create, createConfigureDelegate, getDisplayName

Methods inherited from class org.gradle.api.internal.DefaultNamedDomainObjectSet

filtered, filteredStore, findAll, matching, matching, withType

Methods inherited from class org.gradle.api.internal.DefaultNamedDomainObjectCollection

add, addRule, addRule, assertCanAdd, assertCanAdd, findByName, findByNameWithoutRules, getAsDynamicObject, getAsMap, getAt, getByName, getConvention, getElementsAsDynamicObject, getExtensions, getInstantiator, getNamer, getRules, handleAttemptToAddItemWithNonUniqueName, hasWithName, removeByName

Methods inherited from class org.gradle.api.internal.DefaultDomainObjectCollection

addAll, all, all, assertMutable, beforeChange, clear, contains, containsAll, createFilter, createFilter, createFilter, filteredEvents, findAll, getEventRegister, getStore, getType, isEmpty, iterator, remove, removeAll, retainAll, size, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from class java.util.AbstractCollection

toArray, toArray, 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.artifacts.ConfigurationContainer

getAt, getByName

Methods inherited from interface org.gradle.api.NamedDomainObjectContainer

configure, create, create

Methods inherited from interface org.gradle.api.NamedDomainObjectSet

findAll, matching, matching, withType

Methods inherited from interface org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getNamer, getRules

Methods inherited from interface org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from interface java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Field Detail

DETACHED_CONFIGURATION_DEFAULT_NAME

public static final String DETACHED_CONFIGURATION_DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultConfigurationContainer

public DefaultConfigurationContainer(ArtifactDependencyResolver dependencyResolver,
                             Instantiator instantiator,
                             DomainObjectContext context,
                             ListenerManager listenerManager,
                             DependencyMetaDataProvider dependencyMetaDataProvider)

Method Detail

doCreate

protected Configuration doCreate(String name)

Description copied from class: AbstractNamedDomainObjectContainer

Subclasses need only implement this method as the creation strategy.

Specified by:

doCreate in class AbstractNamedDomainObjectContainer<Configuration>

getAll

public Set<Configuration> getAll()

Specified by:

getAll in interface ConfigurationsProvider

add

public Configuration add(String name)

Description copied from interface: ConfigurationContainer

Adds a configuration with the given name.

Specified by:

add in interface ConfigurationContainer

Parameters:

name - The name of the new configuration.

Returns:

The newly added configuration.

add

public Configuration add(String name,
                Closure closure)

Description copied from interface: ConfigurationContainer

Adds a configuration with the given name. The given configuration closure is executed against the configuration before it is returned from this method.

Specified by:

add in interface ConfigurationContainer

Parameters:

name - The name of the new configuration.

closure - The closure to use to configure the configuration.

Returns:

The newly added configuration.

getByName

public ConfigurationInternal getByName(String name)

Description copied from interface: NamedDomainObjectCollection

Locates an object by name, failing if there is no such object.

Specified by:

getByName in interface ConfigurationContainer

Specified by:

getByName in interface ConfigurationContainerInternal

Specified by:

getByName in interface NamedDomainObjectCollection<Configuration>

Overrides:

getByName in class DefaultNamedDomainObjectCollection<Configuration>

Parameters:

name - The object name

Returns:

The object with the given name. Never returns null.

getTypeDisplayName

public String getTypeDisplayName()

Overrides:

getTypeDisplayName in class DefaultNamedDomainObjectCollection<Configuration>

createNotFoundException

protected UnknownDomainObjectException createNotFoundException(String name)

Overrides:

createNotFoundException in class DefaultNamedDomainObjectCollection<Configuration>

detachedConfiguration

public Configuration detachedConfiguration(Dependency... dependencies)

Description copied from interface: ConfigurationContainer

Creates a configuration, but does not add it to this container.

Specified by:

detachedConfiguration in interface ConfigurationContainer

Parameters:

dependencies - The dependencies of the configuration.

Returns:

The configuration.

dump

public String dump()

Build a formatted representation of all Configurations in this ConfigurationContainer. Configuration(s) being toStringed are likely derivations of DefaultConfiguration.