org.apache.commons.collections.buffer
Class AbstractBufferDecorator

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.buffer.AbstractBufferDecorator
All Implemented Interfaces:
Buffer, Collection
Direct Known Subclasses:
UnmodifiableBuffer

public abstract class AbstractBufferDecorator
extends AbstractCollectionDecorator
implements Buffer

Decorates another Buffer to provide additional behaviour.

Methods are forwarded directly to the decorated buffer.

Since:
Commons Collections 3.0
Version:
$Revision: 1.2 $ $Date: 2004/01/14 21:43:08 $
Author:
Stephen Colebourne

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
 
Constructor Summary
protected AbstractBufferDecorator(Buffer buffer)
          Constructor that wraps (not copies).
 
Method Summary
 Object get()
          Gets the next object from the buffer without removing it.
protected  Buffer getBuffer()
          Gets the buffer being decorated.
 Object 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(Buffer 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 getBuffer()
Gets the buffer being decorated.
Returns:
the decorated buffer

get

public Object get()
Description copied from interface: Buffer
Gets the next object from the buffer without removing it.
Specified by:
get in interface Buffer
Following copied from interface: org.apache.commons.collections.Buffer
Returns:
the next object in the buffer, which is not removed
Throws:
BufferUnderflowException - if the buffer is empty

remove

public Object remove()
Description copied from interface: Buffer
Gets and removes the next object from the buffer.
Specified by:
remove in interface Buffer
Following copied from interface: org.apache.commons.collections.Buffer
Returns:
the next object in the buffer, which is also removed
Throws:
BufferUnderflowException - if the buffer is already empty


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.