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) $
- Author:
- Stephen Colebourne
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanaddAll(Collection coll) voidclear()static BufferFactory method to create an unmodifiable buffer.iterator()remove()Gets and removes the next object from the buffer.booleanbooleanremoveAll(Collection coll) booleanretainAll(Collection coll) Methods inherited from class org.apache.commons.collections.buffer.AbstractBufferDecorator
get, getBufferMethods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
contains, containsAll, equals, getCollection, hashCode, isEmpty, size, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
contains, containsAll, equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray, toArray
-
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
-
iterator
- Specified by:
iteratorin interfaceCollection- Specified by:
iteratorin interfaceIterable- Overrides:
iteratorin classAbstractCollectionDecorator
-
add
- Specified by:
addin interfaceCollection- Overrides:
addin classAbstractCollectionDecorator
-
addAll
- Specified by:
addAllin interfaceCollection- Overrides:
addAllin classAbstractCollectionDecorator
-
clear
public void clear()- Specified by:
clearin interfaceCollection- Overrides:
clearin classAbstractCollectionDecorator
-
remove
- Specified by:
removein interfaceCollection- Overrides:
removein classAbstractCollectionDecorator
-
removeAll
- Specified by:
removeAllin interfaceCollection- Overrides:
removeAllin classAbstractCollectionDecorator
-
retainAll
- Specified by:
retainAllin interfaceCollection- Overrides:
retainAllin classAbstractCollectionDecorator
-
remove
Description copied from interface:BufferGets and removes the next object from the buffer.- Specified by:
removein interfaceBuffer- Overrides:
removein classAbstractBufferDecorator- Returns:
- the next object in the buffer, which is also removed
-