org.gradle.api.internal

Class AbstractNamedDomainObjectContainer<T>

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<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>, DomainObjectCollection<T>, DynamicObjectAware, NamedDomainObjectCollection<T>, NamedDomainObjectContainer<T>, NamedDomainObjectSet<T>, Configurable<NamedDomainObjectContainer<T>>

Direct Known Subclasses:

DefaultConfigurationContainer, DefaultSourceSetContainer, FactoryNamedDomainObjectContainer

public abstract class AbstractNamedDomainObjectContainer<T>
extends DefaultNamedDomainObjectSet<T>
implements NamedDomainObjectContainer<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNamedDomainObjectContainer(Class<T> type, Instantiator instantiator)
protected	AbstractNamedDomainObjectContainer(Class<T> type, Instantiator instantiator, Namer<? super T> namer)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractNamedDomainObjectContainer<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.
protected Object	createConfigureDelegate(Closure configureClosure)
protected abstract T	doCreate(String name) Subclasses need only implement this method as the creation strategy.
String	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, createNotFoundException, findByName, findByNameWithoutRules, getAsDynamicObject, getAsMap, getAt, getByName, getByName, getConvention, getElementsAsDynamicObject, getExtensions, getInstantiator, getNamer, getRules, getTypeDisplayName, 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.NamedDomainObjectSet

findAll, matching, matching, withType

Methods inherited from interface org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, 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

Constructor Detail

AbstractNamedDomainObjectContainer

protected AbstractNamedDomainObjectContainer(Class<T> type,
                                  Instantiator instantiator,
                                  Namer<? super T> namer)

AbstractNamedDomainObjectContainer

protected AbstractNamedDomainObjectContainer(Class<T> type,
                                  Instantiator instantiator)

Method Detail

doCreate

protected abstract T doCreate(String name)

Subclasses need only implement this method as the creation strategy.

create

public T create(String name)

Description copied from interface: NamedDomainObjectContainer

Creates a new item with the given name, adding it to this container.

Specified by:

create in interface NamedDomainObjectContainer<T>

Parameters:

name - The name to assign to the created object

Returns:

The created object. Never null.

create

public T create(String name,
       Closure configureClosure)

Description copied from interface: NamedDomainObjectContainer

Creates a new item with the given name, adding it to this container, then configuring it with the given closure.

Specified by:

create in interface NamedDomainObjectContainer<T>

Parameters:

name - The name to assign to the created object

configureClosure - The closure to configure the created object with

Returns:

The created object. Never null.

createConfigureDelegate

protected Object createConfigureDelegate(Closure configureClosure)

configure

public AbstractNamedDomainObjectContainer<T> configure(Closure configureClosure)

Description copied from interface: NamedDomainObjectContainer

Allows the container to be configured, creating missing objects as they are referenced.

TODO: example usage

Specified by:

configure in interface NamedDomainObjectContainer<T>

Specified by:

configure in interface Configurable<NamedDomainObjectContainer<T>>

Parameters:

configureClosure - The closure to configure this container with

Returns:

This.

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class DefaultNamedDomainObjectSet<T>