Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.collections.buffer

Class UnmodifiableBuffer

Implemented Interfaces:
Serializable, Buffer, Collection, Unmodifiable
public final class UnmodifiableBuffer
extends AbstractBufferDecorator
implements Unmodifiable, Serializable
Decorates another Buffer to ensure it can't be altered.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

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, remove

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

Method Details

add

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

addAll

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

clear

public void clear()
Overrides:
clear in interface AbstractCollectionDecorator

decorate

public static Buffer decorate(Buffer 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

iterator

public Iterator iterator()
Overrides:
iterator in interface AbstractCollectionDecorator

remove

public Object remove()
Gets and removes the next object from the buffer.
Specified by:
remove in interface Buffer
Overrides:
remove in interface AbstractBufferDecorator
Returns:
the next object in the buffer, which is also removed

remove

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

removeAll

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

retainAll

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

Overview Package Class Use Tree Index Deprecated About
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.