org.apache.commons.collections.buffer
Class AbstractBufferDecorator<E>

java.lang.Object
  org.apache.commons.collections.collection.AbstractCollectionDecorator<E>
      org.apache.commons.collections.buffer.AbstractBufferDecorator<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Buffer<E>

Direct Known Subclasses:

UnmodifiableBuffer

public abstract class AbstractBufferDecorator<E>
extends AbstractCollectionDecorator<E>
implements Buffer<E>

Decorates another Buffer to provide additional behaviour.

Methods are forwarded directly to the decorated buffer.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:33:50 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

Field Summary

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

collection

Constructor Summary

protected	AbstractBufferDecorator() Constructor only used in deserialization, do not use otherwise.
protected	AbstractBufferDecorator(Buffer<E> buffer) Constructor that wraps (not copies).

Method Summary

E	get() Gets the next object from the buffer without removing it.
protected Buffer<E>	getBuffer() Gets the buffer being decorated.
E	remove() Gets and removes the next object from the buffer.

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

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

Constructor Detail

AbstractBufferDecorator

protected AbstractBufferDecorator()

Constructor only used in deserialization, do not use otherwise.

Since:

Commons Collections 3.1

AbstractBufferDecorator

protected AbstractBufferDecorator(Buffer<E> buffer)

Constructor that wraps (not copies).

Parameters:

buffer - the buffer to decorate, must not be null

Throws:

IllegalArgumentException - if list is null

Method Detail

getBuffer

protected Buffer<E> getBuffer()

Gets the buffer being decorated.

Returns:

the decorated buffer

get

public E get()

Description copied from interface: Buffer

Gets the next object from the buffer without removing it.

Specified by:

get in interface Buffer<E>

Returns:

the next object in the buffer, which is not removed

remove

public E remove()

Description copied from interface: Buffer

Gets and removes the next object from the buffer.

Specified by:

remove in interface Buffer<E>

Returns:

the next object in the buffer, which is also removed