public class PredicatedBuffer<E> extends PredicatedCollection<E> implements Buffer<E>
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<E> buffer,
Predicate<? super E> predicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected Buffer<E> |
decorated()
Gets the buffer being decorated.
|
E |
get()
Gets the next object from the buffer without removing it.
|
static <E> PredicatedBuffer<E> |
predicatedBuffer(Buffer<E> buffer,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) buffer.
|
E |
remove()
Gets and removes the next object from the buffer.
|
add, addAll, predicatedCollection, validateclear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toStringprotected PredicatedBuffer(Buffer<E> buffer, Predicate<? super E> 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 <E> PredicatedBuffer<E> predicatedBuffer(Buffer<E> buffer, Predicate<? super E> predicate)
If there are any elements already in the buffer being decorated, they are validated.
E - the type of the elements in the bufferbuffer - 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<E> decorated()
decorated in class AbstractCollectionDecorator<E>public E get()
BufferCopyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.