org.gradle.api.internal

Class DefaultDomainObjectCollection<T>

java.lang.Object

java.util.AbstractCollection<T>

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

All Implemented Interfaces:

Iterable<T>, Collection<T>, DomainObjectCollection<T>

Direct Known Subclasses:

DefaultDomainObjectSet, DefaultNamedDomainObjectCollection

public class DefaultDomainObjectCollection<T>
extends AbstractCollection<T>
implements DomainObjectCollection<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultDomainObjectCollection(Class<? extends T> type, Collection<T> store)
protected	DefaultDomainObjectCollection(Class<? extends T> type, Collection<T> store, CollectionEventRegister<T> eventRegister)
protected	DefaultDomainObjectCollection(DefaultDomainObjectCollection<? super T> collection, CollectionFilter<T> filter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T toAdd)
boolean	addAll(Collection<? extends T> c)
void	all(Action<? super T> action) Executes the given action against all objects in this collection, and any objects subsequently added to this collection.
void	all(Closure action) Executes the given closure against all objects in this collection, and any objects subsequently added to this collection.
protected void	assertMutable()
void	beforeChange(Runnable action) Adds an action which is executed before this collection is mutated.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
protected <S extends T> CollectionFilter<S>	createFilter(Class<? extends S> type, Spec<? super S> spec)
protected <S extends T> CollectionFilter<S>	createFilter(Class<S> type)
protected CollectionFilter<T>	createFilter(Spec<? super T> filter)
protected <S extends T> DefaultDomainObjectCollection<S>	filtered(CollectionFilter<S> filter)
protected <S extends T> CollectionEventRegister<S>	filteredEvents(CollectionFilter<S> filter)
protected <S extends T> Collection<S>	filteredStore(CollectionFilter<S> filter)
Collection<T>	findAll(Closure cl) Returns a collection which contains the objects in this collection which meet the given closure specification.
protected <S extends Collection<? super T>> S	findAll(Closure cl, S matches)
protected CollectionEventRegister<T>	getEventRegister()
protected Collection<T>	getStore()
Class<? extends T>	getType()
boolean	isEmpty()
Iterator<T>	iterator()
DomainObjectCollection<T>	matching(Closure spec) Returns a collection which contains the objects in this collection which meet the given closure specification.
DomainObjectCollection<T>	matching(Spec<? super T> spec) Returns a collection which contains the objects in this collection which meet the given specification.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> target)
int	size()
Action<? super T>	whenObjectAdded(Action<? super T> action) Adds an Action to be executed when an object is added to this collection.
void	whenObjectAdded(Closure action) Adds a closure to be called when an object is added to this collection.
Action<? super T>	whenObjectRemoved(Action<? super T> action) Adds an Action to be executed when an object is removed from this collection.
void	whenObjectRemoved(Closure action) Adds a closure to be called when an object is removed from this collection.
<S extends T> DomainObjectCollection<S>	withType(Class<S> type) Returns a collection containing the objects in this collection of the given type.
<S extends T> DomainObjectCollection<S>	withType(Class<S> type, Action<? super S> configureAction) Returns a collection containing the objects in this collection of the given type.
<S extends T> DomainObjectCollection<S>	withType(Class<S> type, Closure configureClosure) Returns a collection containing the objects in this collection of the given type.

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 java.util.Collection

equals, hashCode, toArray, toArray

Constructor Detail

DefaultDomainObjectCollection

public DefaultDomainObjectCollection(Class<? extends T> type,
                             Collection<T> store)

DefaultDomainObjectCollection

protected DefaultDomainObjectCollection(Class<? extends T> type,
                             Collection<T> store,
                             CollectionEventRegister<T> eventRegister)

DefaultDomainObjectCollection

protected DefaultDomainObjectCollection(DefaultDomainObjectCollection<? super T> collection,
                             CollectionFilter<T> filter)

Method Detail

getType

public Class<? extends T> getType()

getStore

protected Collection<T> getStore()

getEventRegister

protected CollectionEventRegister<T> getEventRegister()

createFilter

protected CollectionFilter<T> createFilter(Spec<? super T> filter)

createFilter

protected <S extends T> CollectionFilter<S> createFilter(Class<S> type)

createFilter

protected <S extends T> CollectionFilter<S> createFilter(Class<? extends S> type,
                                             Spec<? super S> spec)

filtered

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

filteredStore

protected <S extends T> Collection<S> filteredStore(CollectionFilter<S> filter)

filteredEvents

protected <S extends T> CollectionEventRegister<S> filteredEvents(CollectionFilter<S> filter)

matching

public DomainObjectCollection<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>

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

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.

withType

public <S extends T> DomainObjectCollection<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>

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.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in class AbstractCollection<T>

all

public void all(Action<? super T> action)

Description copied from interface: DomainObjectCollection

Executes the given action against all objects in this collection, and any objects subsequently added to this collection.

Specified by:

all in interface DomainObjectCollection<T>

Parameters:

action - The action to be executed

all

public void all(Closure action)

Description copied from interface: DomainObjectCollection

Executes the given closure against all objects in this collection, and any objects subsequently added to this collection. The object is passed to the closure as the closure delegate. Alternatively, it is also passed as a parameter.

Specified by:

all in interface DomainObjectCollection<T>

Parameters:

action - The action to be executed

withType

public <S extends T> DomainObjectCollection<S> withType(Class<S> type,
                                               Action<? super S> configureAction)

Description copied from interface: DomainObjectCollection

Returns a collection containing the objects in this collection of the given type. Equivalent to calling withType(type).all(configureAction)

Specified by:

withType in interface DomainObjectCollection<T>

Parameters:

type - The type of objects to find.

configureAction - The action to execute for each object in the resulting collection.

Returns:

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

withType

public <S extends T> DomainObjectCollection<S> withType(Class<S> type,
                                               Closure configureClosure)

Description copied from interface: DomainObjectCollection

Returns a collection containing the objects in this collection of the given type. Equivalent to calling withType(type).all(configureClosure).

Specified by:

withType in interface DomainObjectCollection<T>

Parameters:

type - The type of objects to find.

configureClosure - The closure to execute for each object in the resulting collection.

Returns:

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

whenObjectAdded

public Action<? super T> whenObjectAdded(Action<? super T> action)

Description copied from interface: DomainObjectCollection

Adds an Action to be executed when an object is added to this collection.

Specified by:

whenObjectAdded in interface DomainObjectCollection<T>

Parameters:

action - The action to be executed

Returns:

the supplied action

whenObjectRemoved

public Action<? super T> whenObjectRemoved(Action<? super T> action)

Description copied from interface: DomainObjectCollection

Adds an Action to be executed when an object is removed from this collection.

Specified by:

whenObjectRemoved in interface DomainObjectCollection<T>

Parameters:

action - The action to be executed

Returns:

the supplied action

whenObjectAdded

public void whenObjectAdded(Closure action)

Description copied from interface: DomainObjectCollection

Adds a closure to be called when an object is added to this collection. The newly added object is passed to the closure as the parameter.

Specified by:

whenObjectAdded in interface DomainObjectCollection<T>

Parameters:

action - The closure to be called

whenObjectRemoved

public void whenObjectRemoved(Closure action)

Description copied from interface: DomainObjectCollection

Adds a closure to be called when an object is removed from this collection. The removed object is passed to the closure as the parameter.

Specified by:

whenObjectRemoved in interface DomainObjectCollection<T>

Parameters:

action - The closure to be called

beforeChange

public void beforeChange(Runnable action)

Adds an action which is executed before this collection is mutated. Any exception thrown by the action will veto the mutation.

add

public boolean add(T toAdd)

Specified by:

add in interface Collection<T>

Overrides:

add in class AbstractCollection<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Overrides:

addAll in class AbstractCollection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Overrides:

clear in class AbstractCollection<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Overrides:

contains in class AbstractCollection<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Overrides:

containsAll in class AbstractCollection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Overrides:

isEmpty in class AbstractCollection<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Overrides:

remove in class AbstractCollection<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Overrides:

removeAll in class AbstractCollection<T>

retainAll

public boolean retainAll(Collection<?> target)

Specified by:

retainAll in interface Collection<T>

Overrides:

retainAll in class AbstractCollection<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in class AbstractCollection<T>

findAll

public Collection<T> findAll(Closure cl)

Description copied from interface: DomainObjectCollection

Returns a collection which contains the objects in this collection which meet the given closure specification.

Specified by:

findAll in interface DomainObjectCollection<T>

Parameters:

cl - 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.

findAll

protected <S extends Collection<? super T>> S findAll(Closure cl,
                                          S matches)

assertMutable

protected void assertMutable()