org.apache.commons.collections.buffer

Class PredicatedBuffer

public class PredicatedBuffer extends PredicatedCollection implements Buffer

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.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne Paul Jack

Constructor Summary
protected PredicatedBuffer(Buffer buffer, Predicate predicate)
Constructor that wraps (not copies).
Method Summary
static Bufferdecorate(Buffer buffer, Predicate predicate)
Factory method to create a predicated (validating) buffer.
Objectget()
protected BuffergetBuffer()
Gets the buffer being decorated.
Objectremove()

Constructor Detail

PredicatedBuffer

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

Method Detail

decorate

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

get

public Object get()

getBuffer

protected Buffer getBuffer()
Gets the buffer being decorated.

Returns: the decorated buffer

remove

public Object remove()
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.