org.apache.commons.collections.buffer
Class TransformedBuffer
java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
|
+--org.apache.commons.collections.collection.TransformedCollection
|
+--org.apache.commons.collections.buffer.TransformedBuffer
- All Implemented Interfaces:
- Buffer, Collection
- public class TransformedBuffer
- extends TransformedCollection
- implements Buffer
Decorates another Buffer
to transform objects that are added.
The add methods are affected by this class.
Thus objects must be removed or searched for using their transformed form.
For example, if the transformation converts Strings to Integers, you must
use the Integer form to remove objects.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.2 $ $Date: 2004/01/14 21:43:08 $
- Author:
- Stephen Colebourne
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from interface java.util.Collection |
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
TransformedBuffer
protected TransformedBuffer(Buffer buffer,
Transformer transformer)
- Constructor that wraps (not copies).
If there are any elements already in the buffer being decorated, they
are NOT transformed.
- Parameters:
buffer
- the buffer to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if buffer or transformer is null
decorate
public static Buffer decorate(Buffer buffer,
Transformer transformer)
- Factory method to create a transforming buffer.
If there are any elements already in the buffer being decorated, they
are NOT transformed.
- Parameters:
buffer
- the buffer to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if buffer or transformer is null
getBuffer
protected Buffer getBuffer()
- Gets the decorated buffer.
- Returns:
- the decorated buffer
get
public Object get()
- Description copied from interface:
Buffer
- Gets the next object from the buffer without removing it.
- Specified by:
get
in interface Buffer
- Following copied from interface:
org.apache.commons.collections.Buffer
- Returns:
- the next object in the buffer, which is not removed
- Throws:
BufferUnderflowException
- if the buffer is empty
remove
public Object remove()
- Description copied from interface:
Buffer
- Gets and removes the next object from the buffer.
- Specified by:
remove
in interface Buffer
- Following copied from interface:
org.apache.commons.collections.Buffer
- Returns:
- the next object in the buffer, which is also removed
- Throws:
BufferUnderflowException
- if the buffer is already empty
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.