|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.collection.AbstractCollectionDecorator | +--org.apache.commons.collections.collection.PredicatedCollection
Decorates another Collection
to validate that additions
match a specified predicate.
If an object cannot be added to the collection, an IllegalArgumentException is thrown.
Field Summary | |
protected Predicate |
predicate
The predicate to use |
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
collection |
Constructor Summary | |
protected |
PredicatedCollection(Collection coll,
Predicate predicate)
Constructor that wraps (not copies). |
Method Summary | |
boolean |
add(Object object)
Override to validate the object being added to ensure it matches the predicate. |
boolean |
addAll(Collection coll)
Override to validate the objects being added to ensure they match the predicate. |
static Collection |
decorate(Collection coll,
Predicate predicate)
Factory method to create a predicated (validating) collection. |
protected void |
validate(Object object)
Validates the object being added to ensure it matches the predicate. |
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected final Predicate predicate
Constructor Detail |
protected PredicatedCollection(Collection coll, Predicate predicate)
If there are any elements already in the collection being decorated, they are validated.
coll
- the collection to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if collection or predicate is null
IllegalArgumentException
- if the collection contains invalid elementsMethod Detail |
public static Collection decorate(Collection coll, Predicate predicate)
If there are any elements already in the collection being decorated, they are validated.
coll
- the collection to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if collection or predicate is null
IllegalArgumentException
- if the collection contains invalid elementsprotected void validate(Object object)
The predicate itself should not throw an exception, but return false to indicate that the object cannot be added.
object
- the object being added
IllegalArgumentException
- if the add is invalidpublic boolean add(Object object)
add
in interface Collection
add
in class AbstractCollectionDecorator
object
- the object being added
IllegalArgumentException
- if the add is invalidpublic boolean addAll(Collection coll)
addAll
in interface Collection
addAll
in class AbstractCollectionDecorator
coll
- the collection being added
IllegalArgumentException
- if the add is invalid
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |