|
|||||||||||
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 | +--org.apache.commons.collections.buffer.PredicatedBuffer
Decorates another Buffer
to validate that additions
match a specified predicate.
If an object cannot be added to the collection, an IllegalArgumentException is thrown.
Field Summary |
Fields inherited from class org.apache.commons.collections.collection.PredicatedCollection |
predicate |
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
collection |
Constructor Summary | |
protected |
PredicatedBuffer(Buffer buffer,
Predicate predicate)
Constructor that wraps (not copies). |
Method Summary | |
static Buffer |
decorate(Buffer buffer,
Predicate predicate)
Factory method to create a predicated (validating) buffer. |
Object |
get()
Gets the next object from the buffer without removing it. |
protected Buffer |
getBuffer()
Gets the buffer being decorated. |
Object |
remove()
Gets and removes the next object from the buffer. |
Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection |
add, addAll, decorate, validate |
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 |
Methods inherited from interface java.util.Collection |
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
Constructor Detail |
protected PredicatedBuffer(Buffer buffer, Predicate predicate)
If there are any elements already in the collection being decorated, they are validated.
buffer
- the buffer to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if buffer or predicate is null
IllegalArgumentException
- if the buffer contains invalid elementsMethod Detail |
public static Buffer decorate(Buffer buffer, Predicate predicate)
If there are any elements already in the buffer being decorated, they are validated.
buffer
- the buffer to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if buffer or predicate is null
IllegalArgumentException
- if the buffer contains invalid elementsprotected Buffer getBuffer()
public Object get()
Buffer
get
in interface Buffer
public Object remove()
Buffer
remove
in interface Buffer
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |