public class

TransformedBuffer

extends TransformedCollection
implements Buffer
java.lang.Object
   ↳ org.apache.commons.collections.collection.AbstractCollectionDecorator
     ↳ org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
       ↳ org.apache.commons.collections.collection.TransformedCollection
         ↳ org.apache.commons.collections.buffer.TransformedBuffer

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.TransformedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
TransformedBuffer(Buffer buffer, Transformer transformer)
Constructor that wraps (not copies).
Public Methods
static Buffer decorate(Buffer buffer, Transformer transformer)
Factory method to create a transforming buffer.
Object get()
Gets the next object from the buffer without removing it.
Object remove()
Gets and removes the next object from the buffer.
Protected Methods
Buffer getBuffer()
Gets the decorated buffer.
[Expand]
Inherited Methods
From class org.apache.commons.collections.collection.TransformedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface org.apache.commons.collections.Buffer

Protected Constructors

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

Public Methods

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

public Object get ()

Gets the next object from the buffer without removing it.

Returns
  • the next object in the buffer, which is not removed

public Object remove ()

Gets and removes the next object from the buffer.

Returns
  • the next object in the buffer, which is also removed

Protected Methods

protected Buffer getBuffer ()

Gets the decorated buffer.

Returns
  • the decorated buffer