Interface NamedDomainObjectContainer<T>
-
- Type Parameters:
T
- The type of domain objects in this container.
- All Superinterfaces:
Collection<T>
,org.gradle.util.Configurable<NamedDomainObjectContainer<T>>
,DomainObjectCollection<T>
,Iterable<T>
,NamedDomainObjectCollection<T>
,NamedDomainObjectSet<T>
,Set<T>
- All Known Subinterfaces:
ArtifactTypeContainer
,AuthenticationContainer
,BuildTypeContainer
,ConfigurationContainer
,DistributionContainer
,ExtensiblePolymorphicDomainObjectContainer<T>
,FlavorContainer
,IvyConfigurationContainer
,NativeToolChainRegistry
,PlatformContainer
,PlayDistributionContainer
,PolymorphicDomainObjectContainer<T>
,PublicationContainer
,Repositories
,SourceSetContainer
,TaskContainer
public interface NamedDomainObjectContainer<T> extends NamedDomainObjectSet<T>, org.gradle.util.Configurable<NamedDomainObjectContainer<T>>
A named domain object container is a specialisation of
NamedDomainObjectSet
that adds the ability to create instances of the element type.Implementations may use different strategies for creating new object instances.
Note that a container is an implementation of
SortedSet
, which means that the container is guaranteed to only contain elements with unique names within this container. Furthermore, items are ordered by their name.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NamedDomainObjectContainer<T>
configure(Closure configureClosure)
Allows the container to be configured, creating missing objects as they are referenced.T
create(String name)
Creates a new item with the given name, adding it to this container.T
create(String name, Closure configureClosure)
Creates a new item with the given name, adding it to this container, then configuring it with the given closure.T
create(String name, Action<? super T> configureAction)
Creates a new item with the given name, adding it to this container, then configuring it with the given action.T
maybeCreate(String name)
Looks for an item with the given name, creating and adding it to this container if it does not exist.NamedDomainObjectProvider<T>
register(String name)
Defines a new object, which will be created when it is required.NamedDomainObjectProvider<T>
register(String name, Action<? super T> configurationAction)
Defines a new object, which will be created and configured when it is required.-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType
-
Methods inherited from interface org.gradle.api.NamedDomainObjectCollection
add, addAll, addRule, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getByName, getCollectionSchema, getNamer, getNames, getRules, named, named, named, named
-
Methods inherited from interface org.gradle.api.NamedDomainObjectSet
findAll, matching, matching, withType
-
-
-
-
Method Detail
-
create
T create(String name) throws InvalidUserDataException
Creates a new item with the given name, adding it to this container.- Parameters:
name
- The name to assign to the created object- Returns:
- The created object. Never null.
- Throws:
InvalidUserDataException
- if an object with the given name already exists in this container.
-
maybeCreate
T maybeCreate(String name)
Looks for an item with the given name, creating and adding it to this container if it does not exist.- Parameters:
name
- The name to find or assign to the created object- Returns:
- The found or created object. Never null.
-
create
T create(String name, Closure configureClosure) throws InvalidUserDataException
Creates a new item with the given name, adding it to this container, then configuring it with the given closure.- Parameters:
name
- The name to assign to the created objectconfigureClosure
- The closure to configure the created object with- Returns:
- The created object. Never null.
- Throws:
InvalidUserDataException
- if an object with the given name already exists in this container.
-
create
T create(String name, Action<? super T> configureAction) throws InvalidUserDataException
Creates a new item with the given name, adding it to this container, then configuring it with the given action.- Parameters:
name
- The name to assign to the created objectconfigureAction
- The action to configure the created object with- Returns:
- The created object. Never null.
- Throws:
InvalidUserDataException
- if an object with the given name already exists in this container.
-
configure
NamedDomainObjectContainer<T> configure(Closure configureClosure)
Allows the container to be configured, creating missing objects as they are referenced.
TODO: example usage
- Specified by:
configure
in interfaceorg.gradle.util.Configurable<T>
- Parameters:
configureClosure
- The closure to configure this container with- Returns:
- This.
-
register
NamedDomainObjectProvider<T> register(String name, Action<? super T> configurationAction) throws InvalidUserDataException
Defines a new object, which will be created and configured when it is required. An object is 'required' when the object is located using query methods such asNamedDomainObjectCollection.getByName(java.lang.String)
or whenProvider.get()
is called on the return value of this method.It is generally more efficient to use this method instead of
create(java.lang.String, org.gradle.api.Action)
orcreate(java.lang.String)
, as those methods will eagerly create and configure the object, regardless of whether that object is required for the current build or not. This method, on the other hand, will defer creation and configuration until required.- Parameters:
name
- The name of the object.configurationAction
- The action to run to configure the object. This action runs when the object is required.- Returns:
- A
Provider
that whose value will be the object, when queried. - Throws:
InvalidUserDataException
- If a object with the given name already exists in this project.- Since:
- 4.10
-
register
NamedDomainObjectProvider<T> register(String name) throws InvalidUserDataException
Defines a new object, which will be created when it is required. A object is 'required' when the object is located using query methods such asNamedDomainObjectCollection.getByName(java.lang.String)
or whenProvider.get()
is called on the return value of this method.It is generally more efficient to use this method instead of
create(java.lang.String)
, as that methods will eagerly create he object, regardless of whether that object is required for the current build or not. This method, on the other hand, will defer creation until required.- Parameters:
name
- The name of the object.- Returns:
- A
Provider
that whose value will be the object, when queried. - Throws:
InvalidUserDataException
- If a object with the given name already exists in this project.- Since:
- 4.10
-
-