Class UnmodifiableBoundedCollection<E>
java.lang.Object
org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.UnmodifiableBoundedCollection<E>
- Type Parameters:
E- the type of elements in this collection
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,BoundedCollection<E>,Unmodifiable
public final class UnmodifiableBoundedCollection<E>
extends AbstractCollectionDecorator<E>
implements BoundedCollection<E>, Unmodifiable
UnmodifiableBoundedCollection decorates another
BoundedCollection to ensure it can't be altered.
If a BoundedCollection is first wrapped in some other collection decorator, such as synchronized or predicated, the BoundedCollection methods are no longer accessible. The factory on this class will attempt to retrieve the bounded nature by examining the package scope variables.
This class is Serializable from Commons Collections 3.1.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanaddAll(Collection<? extends E> coll) voidclear()protected BoundedCollection<E> Gets the collection being decorated.booleanisFull()Returns true if this collection is full and no new elements can be added.iterator()intmaxSize()Gets the maximum size of the collection (the bound).booleanbooleanremoveAll(Collection<?> coll) booleanbooleanretainAll(Collection<?> coll) static <E> BoundedCollection<E> unmodifiableBoundedCollection(Collection<? extends E> collection) Factory method to create an unmodifiable bounded collection.static <E> BoundedCollection<E> unmodifiableBoundedCollection(BoundedCollection<? extends E> coll) Factory method to create an unmodifiable bounded collection.Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
contains, containsAll, equals, hashCode, isEmpty, parallelStream, size, spliterator, stream, toArray, toArray
-
Method Details
-
unmodifiableBoundedCollection
public static <E> BoundedCollection<E> unmodifiableBoundedCollection(BoundedCollection<? extends E> coll) Factory method to create an unmodifiable bounded collection.- Type Parameters:
E- the type of the elements in the collection- Parameters:
coll- theBoundedCollectionto decorate, must not be null- Returns:
- a new unmodifiable bounded collection
- Throws:
NullPointerException- ifcollisnull- Since:
- 4.0
-
unmodifiableBoundedCollection
public static <E> BoundedCollection<E> unmodifiableBoundedCollection(Collection<? extends E> collection) Factory method to create an unmodifiable bounded collection.This method is capable of drilling down through up to 1000 other decorators to find a suitable BoundedCollection.
- Type Parameters:
E- the type of the elements in the collection- Parameters:
collection- theBoundedCollectionto decorate, must not be null- Returns:
- a new unmodifiable bounded collection
- Throws:
NullPointerException- if coll is nullIllegalArgumentException- if coll is not aBoundedCollection- Since:
- 4.0
-
add
- Specified by:
addin interfaceCollection<E>- Overrides:
addin classAbstractCollectionDecorator<E>
-
addAll
- Specified by:
addAllin interfaceCollection<E>- Overrides:
addAllin classAbstractCollectionDecorator<E>
-
clear
- Specified by:
clearin interfaceCollection<E>- Overrides:
clearin classAbstractCollectionDecorator<E>
-
decorated
Description copied from class:AbstractCollectionDecoratorGets the collection being decorated. All access to the decorated collection goes via this method.- Overrides:
decoratedin classAbstractCollectionDecorator<E>- Returns:
- the decorated collection
-
isFull
Description copied from interface:BoundedCollectionReturns true if this collection is full and no new elements can be added.- Specified by:
isFullin interfaceBoundedCollection<E>- Returns:
trueif the collection is full.
-
iterator
-
maxSize
Description copied from interface:BoundedCollectionGets the maximum size of the collection (the bound).- Specified by:
maxSizein interfaceBoundedCollection<E>- Returns:
- the maximum number of elements the collection can hold.
-
remove
- Specified by:
removein interfaceCollection<E>- Overrides:
removein classAbstractCollectionDecorator<E>
-
removeAll
- Specified by:
removeAllin interfaceCollection<E>- Overrides:
removeAllin classAbstractCollectionDecorator<E>
-
removeIf
- Specified by:
removeIfin interfaceCollection<E>- Overrides:
removeIfin classAbstractCollectionDecorator<E>- Since:
- 4.4
-
retainAll
- Specified by:
retainAllin interfaceCollection<E>- Overrides:
retainAllin classAbstractCollectionDecorator<E>
-