org.apache.commons.collections.buffer
Class UnmodifiableBuffer

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

public final class UnmodifiableBuffer
extends AbstractBufferDecorator
implements Unmodifiable

Decorates another Buffer to ensure it can't be altered.

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

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
 
Method Summary
 boolean add(Object object)
           
 boolean addAll(Collection coll)
           
 void clear()
           
static Buffer decorate(Buffer buffer)
          Factory method to create an unmodifiable buffer.
 Iterator iterator()
           
 Object remove()
          Gets and removes the next object from the buffer.
 boolean remove(Object object)
           
 boolean removeAll(Collection coll)
           
 boolean retainAll(Collection coll)
           
 
Methods inherited from class org.apache.commons.collections.buffer.AbstractBufferDecorator
get, getBuffer
 
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
contains, containsAll, equals, getCollection, hashCode, isEmpty, 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
contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray
 

Method Detail

decorate

public static Buffer decorate(Buffer buffer)
Factory method to create an unmodifiable buffer.
Parameters:
buffer - the buffer to decorate, must not be null
Throws:
IllegalArgumentException - if buffer is null

iterator

public Iterator iterator()
Overrides:
iterator in class AbstractCollectionDecorator

add

public boolean add(Object object)
Overrides:
add in class AbstractCollectionDecorator

addAll

public boolean addAll(Collection coll)
Overrides:
addAll in class AbstractCollectionDecorator

clear

public void clear()
Overrides:
clear in class AbstractCollectionDecorator

remove

public boolean remove(Object object)
Overrides:
remove in class AbstractCollectionDecorator

removeAll

public boolean removeAll(Collection coll)
Overrides:
removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(Collection coll)
Overrides:
retainAll in class AbstractCollectionDecorator

remove

public Object remove()
Description copied from interface: Buffer
Gets and removes the next object from the buffer.
Overrides:
remove in class AbstractBufferDecorator
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.