|
||||||||||
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<E> org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator<E> org.apache.commons.collections.collection.PredicatedCollection<E>
public class PredicatedCollection<E>
Decorates another Collection
to validate that additions
match a specified predicate.
Collection coll = PredicatedCollection.decorate(new ArrayList(), NotNullPredicate.INSTANCE);This class is Serializable from Commons Collections 3.1.
Field Summary | |
---|---|
protected Predicate<? super E> |
predicate
The predicate to use |
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
---|
collection |
Constructor Summary | |
---|---|
protected |
PredicatedCollection(Collection<E> coll,
Predicate<? super E> predicate)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
boolean |
add(E object)
Override to validate the object being added to ensure it matches the predicate. |
|
boolean |
addAll(Collection<? extends E> coll)
Override to validate the objects being added to ensure they match the predicate. |
|
static
|
decorate(Collection<E> coll,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) collection. |
|
protected void |
validate(E 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<? super E> predicate
Constructor Detail |
---|
protected PredicatedCollection(Collection<E> coll, Predicate<? super E> predicate)
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 <E> Collection decorate(Collection<E> coll, Predicate<? super E> predicate)
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(E object)
object
- the object being added
IllegalArgumentException
- if the add is invalidpublic boolean add(E object)
add
in interface Collection<E>
add
in class AbstractCollectionDecorator<E>
object
- the object being added
IllegalArgumentException
- if the add is invalidpublic boolean addAll(Collection<? extends E> coll)
addAll
in interface Collection<E>
addAll
in class AbstractCollectionDecorator<E>
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 |