⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
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:
Collection, Buffer


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
Author:
Stephen Colebourne

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()

Buffer

getBuffer()

Gets the decorated buffer.

Object

remove()

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
Throws:
- if buffer or transformer is 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
Throws:
- 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()