org.apache.commons.collections.buffer

Class TransformedBuffer

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.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.

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Buffer	decorate(Buffer buffer, Transformer transformer) Factory method to create a transforming buffer.
java.lang.Object	get() Gets the next object from the buffer without removing it.
java.lang.Object	remove() Gets and removes the next object from the buffer.

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

add, addAll, decorate

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

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:

java.lang.IllegalArgumentException - if buffer or transformer is null

get

public java.lang.Object get()

Description copied from interface: Buffer

Gets the next object from the buffer without removing it.

Specified by:

get in interface Buffer

Returns:

the next object in the buffer, which is not removed

remove

public java.lang.Object remove()

Description copied from interface: Buffer

Gets and removes the next object from the buffer.

Specified by:

remove in interface Buffer

Returns:

the next object in the buffer, which is also removed