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:
Serializable
,Iterable
,Collection
,Buffer
,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.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serialization versionFields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
UnmodifiableBuffer
(Buffer buffer) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
addAll
(Collection coll) void
clear()
static Buffer
Factory method to create an unmodifiable buffer.iterator()
private void
Read the collection in using a custom routine.remove()
Gets and removes the next object from the buffer.boolean
boolean
removeAll
(Collection coll) boolean
retainAll
(Collection coll) private void
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
Methods inherited from interface java.util.Collection
contains, containsAll, equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray, toArray
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialization version- See Also:
-
-
Constructor Details
-
UnmodifiableBuffer
Constructor that wraps (not copies).- Parameters:
buffer
- the buffer to decorate, must not be null- Throws:
IllegalArgumentException
- if buffer is null
-
-
Method Details
-
decorate
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
-
writeObject
Write the collection out using a custom routine.- Parameters:
out
- the output stream- Throws:
IOException
-
readObject
Read the collection in using a custom routine.- Parameters:
in
- the input stream- Throws:
IOException
ClassNotFoundException
-
iterator
- Specified by:
iterator
in interfaceCollection
- Specified by:
iterator
in interfaceIterable
- Overrides:
iterator
in classAbstractCollectionDecorator
-
add
- Specified by:
add
in interfaceCollection
- Overrides:
add
in classAbstractCollectionDecorator
-
addAll
- Specified by:
addAll
in interfaceCollection
- Overrides:
addAll
in classAbstractCollectionDecorator
-
clear
public void clear()- Specified by:
clear
in interfaceCollection
- Overrides:
clear
in classAbstractCollectionDecorator
-
remove
- Specified by:
remove
in interfaceCollection
- Overrides:
remove
in classAbstractCollectionDecorator
-
removeAll
- Specified by:
removeAll
in interfaceCollection
- Overrides:
removeAll
in classAbstractCollectionDecorator
-
retainAll
- Specified by:
retainAll
in interfaceCollection
- Overrides:
retainAll
in classAbstractCollectionDecorator
-
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
-