public class

PredicatedBuffer

extends PredicatedCollection
implements Buffer
java.lang.Object
   ↳ org.apache.commons.collections.collection.AbstractCollectionDecorator
     ↳ org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
       ↳ org.apache.commons.collections.collection.PredicatedCollection
         ↳ org.apache.commons.collections.buffer.PredicatedBuffer

Class Overview

Decorates another 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.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
PredicatedBuffer(Buffer buffer, Predicate predicate)
Constructor that wraps (not copies).
Public Methods
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.
Object remove()
Gets and removes the next object from the buffer.
Protected Methods
Buffer getBuffer()
Gets the buffer being decorated.
[Expand]
Inherited Methods
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface org.apache.commons.collections.Buffer

Protected Constructors

protected PredicatedBuffer (Buffer buffer, Predicate predicate)

Constructor that wraps (not copies).

If there are any elements already in the collection being decorated, they are validated.

Parameters
buffer the buffer to decorate, must not be null
predicate the predicate to use for validation, must not be null
Throws
IllegalArgumentException if buffer or predicate is null
IllegalArgumentException if the buffer contains invalid elements

Public Methods

public static Buffer decorate (Buffer buffer, Predicate predicate)

Factory method to create a predicated (validating) buffer.

If there are any elements already in the buffer being decorated, they are validated.

Parameters
buffer the buffer to decorate, must not be null
predicate the predicate to use for validation, must not be null
Returns
  • a new predicated Buffer
Throws
IllegalArgumentException if buffer or predicate is null
IllegalArgumentException if the buffer contains invalid elements

public Object get ()

Gets the next object from the buffer without removing it.

Returns
  • the next object in the buffer, which is not removed

public Object remove ()

Gets and removes the next object from the buffer.

Returns
  • the next object in the buffer, which is also removed

Protected Methods

protected Buffer getBuffer ()

Gets the buffer being decorated.

Returns
  • the decorated buffer