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

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

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Buffer<E>, Unmodifiable

public final class UnmodifiableBuffer<E>
extends AbstractBufferDecorator<E>
implements Unmodifiable, Serializable

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

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

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

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Field Summary

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

collection

Method Summary

boolean	add(E object)
boolean	addAll(Collection<? extends E> coll)
void	clear()
static <E> Buffer<E>	decorate(Buffer<E> buffer) Factory method to create an unmodifiable buffer.
Iterator<E>	iterator()
E	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 <E> Buffer<E> decorate(Buffer<E> buffer)

Factory method to create an unmodifiable buffer.

If the buffer passed in is already unmodifiable, it is returned.

Parameters:

buffer - the buffer to decorate, must not be null

Returns:

an unmodifiable Buffer

Throws:

IllegalArgumentException - if buffer is null

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(E object)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

public boolean addAll(Collection<? extends E> coll)

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(Collection<?> coll)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(Collection<?> coll)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollectionDecorator<E>

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>

Overrides:

remove in class AbstractBufferDecorator<E>

Returns:

the next object in the buffer, which is also removed