org.gradle.api.internal

Class DefaultNamedDomainObjectCollection<T>

java.lang.Object

java.util.AbstractCollection<T>

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

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

All Implemented Interfaces:

Iterable<T>, Collection<T>, DomainObjectCollection<T>, DynamicObjectAware, NamedDomainObjectCollection<T>

Direct Known Subclasses:

DefaultNamedDomainObjectList, DefaultNamedDomainObjectSet

public class DefaultNamedDomainObjectCollection<T>
extends DefaultDomainObjectCollection<T>
implements NamedDomainObjectCollection<T>, DynamicObjectAware

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultNamedDomainObjectCollection(Class<? extends T> type, Collection<T> store, CollectionEventRegister<T> eventRegister, Instantiator instantiator, Namer<? super T> namer)
	DefaultNamedDomainObjectCollection(Class<? extends T> type, Collection<T> store, Instantiator instantiator, Namer<? super T> namer)
	DefaultNamedDomainObjectCollection(DefaultNamedDomainObjectCollection<? super T> collection, CollectionFilter<T> filter, Instantiator instantiator, Namer<? super T> namer)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T o) Subclasses that can guarantee that the backing store enforces name uniqueness should override this to simply call super.add(T) (avoiding an unnecessary lookup)
Rule	addRule(Rule rule) Adds a rule to this collection.
Rule	addRule(String description, Closure ruleAction) Adds a rule to this collection.
protected void	assertCanAdd(String name) Asserts that an item with the given name can be added to this collection.
protected void	assertCanAdd(T t) Asserts that the given item can be added to this collection.
protected UnknownDomainObjectException	createNotFoundException(String name)
protected <S extends T> DefaultNamedDomainObjectCollection<S>	filtered(CollectionFilter<S> filter) Creates a filtered version of this collection.
T	findByName(String name) Locates an object by name, returning null if there is no such object.
protected T	findByNameWithoutRules(String name)
DynamicObject	getAsDynamicObject() Returns a DynamicObject which can be used to access the domain objects as dynamic properties and methods.
SortedMap<String,T>	getAsMap() Returns the objects in this collection, as a map from object name to object instance.
T	getAt(String name) Locates an object by name, failing if there is no such task.
T	getByName(String name) Locates an object by name, failing if there is no such object.
T	getByName(String name, Closure configureClosure) Locates an object by name, failing if there is no such object.
Convention	getConvention()
String	getDisplayName()
protected DynamicObject	getElementsAsDynamicObject()
ExtensionContainer	getExtensions()
protected Instantiator	getInstantiator()
Namer<T>	getNamer() An object that represents the naming strategy used to name objects of this collection.
List<Rule>	getRules() Returns the rules used by this collection.
protected String	getTypeDisplayName()
protected void	handleAttemptToAddItemWithNonUniqueName(T o) Subclass hook for implementations wanting to throw an exception when an attempt is made to add an item with the same name as an existing item.
protected boolean	hasWithName(String name)
NamedDomainObjectCollection<T>	matching(Closure spec) Returns a collection which contains the objects in this collection which meet the given closure specification.
NamedDomainObjectCollection<T>	matching(Spec<? super T> spec) Returns a collection which contains the objects in this collection which meet the given specification.
protected T	removeByName(String name)
<S extends T> NamedDomainObjectCollection<S>	withType(Class<S> type) Returns a collection containing the objects in this collection of the given type.

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

addAll, all, all, assertMutable, beforeChange, clear, contains, containsAll, createFilter, createFilter, createFilter, filteredEvents, filteredStore, findAll, 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.NamedDomainObjectCollection

addAll

Methods inherited from interface org.gradle.api.DomainObjectCollection

all, all, findAll, 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

Constructor Detail

DefaultNamedDomainObjectCollection

public DefaultNamedDomainObjectCollection(Class<? extends T> type,
                                  Collection<T> store,
                                  Instantiator instantiator,
                                  Namer<? super T> namer)

DefaultNamedDomainObjectCollection

protected DefaultNamedDomainObjectCollection(Class<? extends T> type,
                                  Collection<T> store,
                                  CollectionEventRegister<T> eventRegister,
                                  Instantiator instantiator,
                                  Namer<? super T> namer)

DefaultNamedDomainObjectCollection

public DefaultNamedDomainObjectCollection(DefaultNamedDomainObjectCollection<? super T> collection,
                                  CollectionFilter<T> filter,
                                  Instantiator instantiator,
                                  Namer<? super T> namer)

Method Detail

add

public boolean add(T o)

Subclasses that can guarantee that the backing store enforces name uniqueness should override this to simply call super.add(T) (avoiding an unnecessary lookup)

Specified by:

add in interface Collection<T>

Specified by:

add in interface NamedDomainObjectCollection<T>

Overrides:

add in class DefaultDomainObjectCollection<T>

Parameters:

o - the item to add to the collection

Returns:

true if the item was added, or false if an item with the same name already exists.

handleAttemptToAddItemWithNonUniqueName

protected void handleAttemptToAddItemWithNonUniqueName(T o)

Subclass hook for implementations wanting to throw an exception when an attempt is made to add an item with the same name as an existing item.

This implementation does not thrown an exception, meaning that add(T) will simply return false.

Parameters:

o - The item that is being attempted to add.

assertCanAdd

protected void assertCanAdd(String name)

Asserts that an item with the given name can be added to this collection.

assertCanAdd

protected void assertCanAdd(T t)

Asserts that the given item can be added to this collection.

getNamer

public Namer<T> getNamer()

Description copied from interface: NamedDomainObjectCollection

An object that represents the naming strategy used to name objects of this collection.

Specified by:

getNamer in interface NamedDomainObjectCollection<T>

getInstantiator

protected Instantiator getInstantiator()

filtered

protected <S extends T> DefaultNamedDomainObjectCollection<S> filtered(CollectionFilter<S> filter)

Creates a filtered version of this collection.

Overrides:

filtered in class DefaultDomainObjectCollection<T>

getDisplayName

public String getDisplayName()

getAsMap

public SortedMap<String,T> getAsMap()

Description copied from interface: NamedDomainObjectCollection

Returns the objects in this collection, as a map from object name to object instance.

The map is ordered by the natural ordering of the object names (i.e. keys).

Specified by:

getAsMap in interface NamedDomainObjectCollection<T>

Returns:

The objects. Returns an empty map if this collection is empty.

withType

public <S extends T> NamedDomainObjectCollection<S> withType(Class<S> type)

Description copied from interface: DomainObjectCollection

Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.

Specified by:

withType in interface DomainObjectCollection<T>

Specified by:

withType in interface NamedDomainObjectCollection<T>

Overrides:

withType in class DefaultDomainObjectCollection<T>

Parameters:

type - The type of objects to find.

Returns:

The matching objects. Returns an empty collection if there are no such objects in this collection.

matching

public NamedDomainObjectCollection<T> matching(Spec<? super T> spec)

Description copied from interface: DomainObjectCollection

Returns a collection which contains the objects in this collection which meet the given specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

Specified by:

matching in interface DomainObjectCollection<T>

Specified by:

matching in interface NamedDomainObjectCollection<T>

Overrides:

matching in class DefaultDomainObjectCollection<T>

Parameters:

spec - The specification to use.

Returns:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

matching

public NamedDomainObjectCollection<T> matching(Closure spec)

Description copied from interface: DomainObjectCollection

Returns a collection which contains the objects in this collection which meet the given closure specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

Specified by:

matching in interface DomainObjectCollection<T>

Specified by:

matching in interface NamedDomainObjectCollection<T>

Overrides:

matching in class DefaultDomainObjectCollection<T>

Parameters:

spec - The specification to use. The closure gets a collection element as an argument.

Returns:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

findByName

public T findByName(String name)

Description copied from interface: NamedDomainObjectCollection

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

Specified by:

findByName in interface NamedDomainObjectCollection<T>

Parameters:

name - The object name

Returns:

The object with the given name, or null if there is no such object in this collection.

hasWithName

protected boolean hasWithName(String name)

findByNameWithoutRules

protected T findByNameWithoutRules(String name)

removeByName

protected T removeByName(String name)

getByName

public T getByName(String name)
            throws UnknownDomainObjectException

Description copied from interface: NamedDomainObjectCollection

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

Specified by:

getByName in interface NamedDomainObjectCollection<T>

Parameters:

name - The object name

Returns:

The object with the given name. Never returns null.

Throws:

UnknownDomainObjectException - when there is no such object in this collection.

getByName

public T getByName(String name,
          Closure configureClosure)
            throws UnknownDomainObjectException

Description copied from interface: NamedDomainObjectCollection

Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as it's delegate.

Specified by:

getByName in interface NamedDomainObjectCollection<T>

Parameters:

name - The object name

configureClosure - The closure to use to configure the object.

Returns:

The object with the given name, after the configure closure has been applied to it. Never returns null.

Throws:

UnknownDomainObjectException - when there is no such object in this collection.

getAt

public T getAt(String name)
        throws UnknownDomainObjectException

Description copied from interface: NamedDomainObjectCollection

Locates an object by name, failing if there is no such task. This method is identical to NamedDomainObjectCollection.getByName(String). You can call this method in your build script by using the groovy [] operator.

Specified by:

getAt in interface NamedDomainObjectCollection<T>

Parameters:

name - The object name

Returns:

The object with the given name. Never returns null.

Throws:

UnknownDomainObjectException - when there is no such object in this collection.

getAsDynamicObject

public DynamicObject getAsDynamicObject()

Returns a DynamicObject which can be used to access the domain objects as dynamic properties and methods.

Specified by:

getAsDynamicObject in interface DynamicObjectAware

Returns:

The dynamic object

getConvention

public Convention getConvention()

getExtensions

public ExtensionContainer getExtensions()

getElementsAsDynamicObject

protected DynamicObject getElementsAsDynamicObject()

addRule

public Rule addRule(Rule rule)

Description copied from interface: NamedDomainObjectCollection

Adds a rule to this collection. The given rule is invoked when an unknown object is requested by name.

Specified by:

addRule in interface NamedDomainObjectCollection<T>

Parameters:

rule - The rule to add.

Returns:

The added rule.

addRule

public Rule addRule(String description,
           Closure ruleAction)

Description copied from interface: NamedDomainObjectCollection

Adds a rule to this collection. The given closure is executed when an unknown object is requested by name. The requested name is passed to the closure as a parameter.

Specified by:

addRule in interface NamedDomainObjectCollection<T>

Parameters:

description - The description of the rule.

ruleAction - The closure to execute to apply the rule.

Returns:

The added rule.

getRules

public List<Rule> getRules()

Description copied from interface: NamedDomainObjectCollection

Returns the rules used by this collection.

Specified by:

getRules in interface NamedDomainObjectCollection<T>

Returns:

The rules, in the order they will be applied.

createNotFoundException

protected UnknownDomainObjectException createNotFoundException(String name)

getTypeDisplayName

protected String getTypeDisplayName()