public class PredicatedBuffer extends PredicatedCollection implements Buffer
Buffer to validate that additions
match a specified predicate.
This buffer exists to provide validation for the decorated buffer. It is normally created to decorate an empty buffer. If an object cannot be added to the buffer, an IllegalArgumentException is thrown.
One usage would be to ensure that no null entries are added to the buffer.
Buffer buffer = PredicatedBuffer.decorate(new UnboundedFifoBuffer(), NotNullPredicate.INSTANCE);
This class is Serializable from Commons Collections 3.1.
predicatecollection| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedBuffer(Buffer buffer,
Predicate predicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
add, addAll, decorate, validateclear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toStringprotected 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 nullIllegalArgumentException - if buffer or predicate is nullIllegalArgumentException - if the buffer contains invalid elementspublic 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 nullIllegalArgumentException - if buffer or predicate is nullIllegalArgumentException - if the buffer contains invalid elementsprotected Buffer getBuffer()
public Object get()
BufferCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.