org.apache.commons.collections.buffer

Class TransformedBuffer

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.

Since: Commons Collections 3.0

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

Author: Stephen Colebourne

Constructor Summary
protected TransformedBuffer(Buffer buffer, Transformer transformer)
Constructor that wraps (not copies).
Method Summary
static Bufferdecorate(Buffer buffer, Transformer transformer)
Factory method to create a transforming buffer.
Objectget()
protected BuffergetBuffer()
Gets the decorated buffer.
Objectremove()

Constructor Detail

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

Throws: IllegalArgumentException if buffer or transformer is null

Method Detail

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

Throws: IllegalArgumentException if buffer or transformer is null

get

public Object get()

getBuffer

protected Buffer getBuffer()
Gets the decorated buffer.

Returns: the decorated buffer

remove

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