org.apache.commons.collections.buffer

Class TransformedBuffer

Implemented Interfaces:
Buffer, Collection, Serializable

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.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.6 $ $Date: 2004/06/03 22:02:13 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

Fields inherited from class org.apache.commons.collections.collection.TransformedCollection

transformer

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

collection

Constructor Summary

TransformedBuffer(Buffer buffer, Transformer transformer)
Constructor that wraps (not copies).

Method Summary

static Buffer
decorate(Buffer buffer, Transformer transformer)
Factory method to create a transforming buffer.
Object
get()
protected Buffer
getBuffer()
Gets the decorated buffer.
Object
remove()

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

add, addAll, decorate, transform, transform

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

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

Constructor Details

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 null
transformer - the transformer to use for conversion, must not be null

Method Details

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 null
transformer - the transformer to use for conversion, must not be null
Returns:
a new transformed Buffer

get

public Object get()
Specified by:
get in interface Buffer

getBuffer

protected Buffer getBuffer()
Gets the decorated buffer.
Returns:
the decorated buffer

remove

public Object remove()
Specified by:
remove in interface Buffer

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.