org.apache.commons.collections.buffer
Class PredicatedBuffer

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.collection.PredicatedCollection
              |
              +--org.apache.commons.collections.buffer.PredicatedBuffer

All Implemented Interfaces:

Buffer, java.util.Collection

public class PredicatedBuffer

extends PredicatedCollection

implements Buffer

Decorates another Buffer to validate that additions match a specified predicate.

If an object cannot be added to the collection, an IllegalArgumentException is thrown.

Since:

Commons Collections 3.0

Version:

$Revision: 1.2 $ $Date: 2004/01/14 21:43:08 $

Author:

Stephen Colebourne, Paul Jack

Method Summary

static Buffer	decorate(Buffer buffer, Predicate predicate) Factory method to create a predicated (validating) buffer.
java.lang.Object	get() Gets the next object from the buffer without removing it.
java.lang.Object	remove() Gets and removes the next object from the buffer.

Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection

add, addAll, decorate

Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

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

Throws:

java.lang.IllegalArgumentException - if buffer or predicate is null

java.lang.IllegalArgumentException - if the buffer contains invalid elements

get

public java.lang.Object get()

Description copied from interface: Buffer

Gets the next object from the buffer without removing it.

Specified by:

get in interface Buffer

Returns:

the next object in the buffer, which is not removed

remove

public java.lang.Object remove()

Description copied from interface: Buffer

Gets and removes the next object from the buffer.

Specified by:

remove in interface Buffer

Returns:

the next object in the buffer, which is also removed