|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- The type of domain objects in this collection.public interface DomainObjectCollection<T>
A DomainObjectCollection
represents a read-only set of domain objects of type T
.
The object in a collection are accessable as read-only properties of the collection, using the name of the object as the property name. For example:
tasks.add('myTask') tasks.myTask.dependsOn someOtherTask
A dynamic method is added for each object which takes a configuration closure. This is equivalent to calling
getByName(String, groovy.lang.Closure)
. For example:
tasks.add('myTask') tasks.myTask { dependsOn someOtherTask }
You can also use the []
operator to access the objects of a collection by name. For example:
tasks.add('myTask') tasks['myTask'].dependsOn someOtherTask
Method Summary | ||
---|---|---|
void |
allObjects(Action<? super T> action)
Executes the given action against all objects in this collection, and any objects subsequently added to this collection. |
|
void |
allObjects(groovy.lang.Closure action)
Executes the given closure against all objects in this collection, and any objects subsequently added to this collection. |
|
java.util.Set<T> |
findAll(Spec<? super T> spec)
Returns the objects in this collection which meet the given specification. |
|
T |
findByName(java.lang.String name)
Locates an object by name, returning null if there is no such object. |
|
java.util.Set<T> |
getAll()
Returns the objects in this collection. |
|
java.util.Map<java.lang.String,T> |
getAsMap()
Returns the objects in this collection, as a map from object name to object instance. |
|
T |
getAt(java.lang.String name)
Locates an object by name, failing if there is no such task. |
|
T |
getByName(java.lang.String name)
Locates an object by name, failing if there is no such object. |
|
T |
getByName(java.lang.String name,
groovy.lang.Closure configureClosure)
Locates an object by name, failing if there is no such object. |
|
DomainObjectCollection<T> |
matching(Spec<? super T> spec)
Returns a collection which contains the objects in this collection which meet the given specification. |
|
Action<? super T> |
whenObjectAdded(Action<? super T> action)
Adds an Action to be executed when an object is added to this collection. |
|
void |
whenObjectAdded(groovy.lang.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. |
|
|
withType(java.lang.Class<S> type)
Returns a collection containing the objects in this collection of the given type. |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Method Detail |
---|
java.util.Set<T> getAll()
java.util.Map<java.lang.String,T> getAsMap()
T findByName(java.lang.String name)
name
- The object name
T getByName(java.lang.String name) throws UnknownDomainObjectException
name
- The object name
UnknownDomainObjectException
- when there is no such object in this collection.T getByName(java.lang.String name, groovy.lang.Closure configureClosure) throws UnknownDomainObjectException
name
- The object nameconfigureClosure
- The closure to use to configure the object.
UnknownDomainObjectException
- when there is no such object in this collection.T getAt(java.lang.String name) throws UnknownDomainObjectException
getByName(String)
. You can call this method in your build script by using the groovy []
operator.
name
- The object name
UnknownDomainObjectException
- when there is no such object in this collection.java.util.Set<T> findAll(Spec<? super T> spec)
spec
- The specification to use.
<S extends T> DomainObjectCollection<S> withType(java.lang.Class<S> type)
type
- The type of objects to find.
DomainObjectCollection<T> matching(Spec<? super T> spec)
spec
- The specification to use.
Action<? super T> whenObjectAdded(Action<? super T> action)
Action
to be executed when an object is added to this collection.
action
- The action to be executed
void whenObjectAdded(groovy.lang.Closure action)
action
- The closure to be calledAction<? super T> whenObjectRemoved(Action<? super T> action)
Action
to be executed when an object is removed from this collection.
action
- The action to be executed
void allObjects(Action<? super T> action)
action
- The action to be executedvoid allObjects(groovy.lang.Closure action)
action
- The closure to be called
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |