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:
java.io.Serializable
,java.lang.Iterable
,java.util.Collection
,Buffer
,Unmodifiable
public final class UnmodifiableBuffer extends AbstractBufferDecorator implements Unmodifiable, java.io.Serializable
Decorates anotherBuffer
to ensure it can't be altered.This class is Serializable from Commons Collections 3.1.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serialization version-
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
-
-
Constructor Summary
Constructors Modifier Constructor Description private
UnmodifiableBuffer(Buffer buffer)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(java.lang.Object object)
boolean
addAll(java.util.Collection coll)
void
clear()
static Buffer
decorate(Buffer buffer)
Factory method to create an unmodifiable buffer.java.util.Iterator
iterator()
private void
readObject(java.io.ObjectInputStream in)
Read the collection in using a custom routine.java.lang.Object
remove()
Gets and removes the next object from the buffer.boolean
remove(java.lang.Object object)
boolean
removeAll(java.util.Collection coll)
boolean
retainAll(java.util.Collection coll)
private void
writeObject(java.io.ObjectOutputStream out)
Write the collection out using a custom routine.-
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization version- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UnmodifiableBuffer
private UnmodifiableBuffer(Buffer buffer)
Constructor that wraps (not copies).- Parameters:
buffer
- the buffer to decorate, must not be null- Throws:
java.lang.IllegalArgumentException
- if buffer is null
-
-
Method Detail
-
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
- Throws:
java.lang.IllegalArgumentException
- if buffer is null
-
writeObject
private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
Write the collection out using a custom routine.- Parameters:
out
- the output stream- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
Read the collection in using a custom routine.- Parameters:
in
- the input stream- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
iterator
public java.util.Iterator iterator()
- Specified by:
iterator
in interfacejava.util.Collection
- Specified by:
iterator
in interfacejava.lang.Iterable
- Overrides:
iterator
in classAbstractCollectionDecorator
-
add
public boolean add(java.lang.Object object)
- Specified by:
add
in interfacejava.util.Collection
- Overrides:
add
in classAbstractCollectionDecorator
-
addAll
public boolean addAll(java.util.Collection coll)
- Specified by:
addAll
in interfacejava.util.Collection
- Overrides:
addAll
in classAbstractCollectionDecorator
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Collection
- Overrides:
clear
in classAbstractCollectionDecorator
-
remove
public boolean remove(java.lang.Object object)
- Specified by:
remove
in interfacejava.util.Collection
- Overrides:
remove
in classAbstractCollectionDecorator
-
removeAll
public boolean removeAll(java.util.Collection coll)
- Specified by:
removeAll
in interfacejava.util.Collection
- Overrides:
removeAll
in classAbstractCollectionDecorator
-
retainAll
public boolean retainAll(java.util.Collection coll)
- Specified by:
retainAll
in interfacejava.util.Collection
- Overrides:
retainAll
in classAbstractCollectionDecorator
-
remove
public java.lang.Object remove()
Description copied from interface:Buffer
Gets and removes the next object from the buffer.- Specified by:
remove
in interfaceBuffer
- Overrides:
remove
in classAbstractBufferDecorator
- Returns:
- the next object in the buffer, which is also removed
-
-