Class FixedSizeList<E>
java.lang.Object
org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.list.AbstractListDecorator<E>
org.apache.commons.collections4.list.AbstractSerializableListDecorator<E>
org.apache.commons.collections4.list.FixedSizeList<E>
- Type Parameters:
E- the type of elements in this collection
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,List<E>,BoundedCollection<E>
public class FixedSizeList<E>
extends AbstractSerializableListDecorator<E>
implements BoundedCollection<E>
Decorates another
List to fix the size preventing add/remove.
The add, remove, clear and retain operations are unsupported. The set method is allowed (as it doesn't change the list size).
NOTE: Modifying the decorated list directly would results in influencing the outcome of method calls on this object. For example, the bounds of this list would reflect a newly added object to the underlying list.
This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFixedSizeList(List<E> list) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoidbooleanbooleanaddAll(int index, Collection<? extends E> coll) booleanaddAll(Collection<? extends E> coll) voidclear()static <E> FixedSizeList<E> fixedSizeList(List<E> list) Factory method to create a fixed size list.get(int index) intbooleanisFull()Returns true if this collection is full and no new elements can be added.iterator()intlastIndexOf(Object object) listIterator(int index) intmaxSize()Gets the maximum size of the collection (the bound).remove(int index) booleanbooleanremoveAll(Collection<?> coll) booleanbooleanretainAll(Collection<?> coll) subList(int fromIndex, int toIndex) Methods inherited from class org.apache.commons.collections4.list.AbstractListDecorator
decorated, equals, hashCodeMethods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
parallelStream, streamMethods inherited from interface java.util.List
contains, containsAll, isEmpty, replaceAll, size, sort, spliterator, toArray, toArray
-
Constructor Details
-
FixedSizeList
Constructor that wraps (not copies).- Parameters:
list- the list to decorate, must not be null- Throws:
NullPointerException- if list is null
-
-
Method Details
-
fixedSizeList
Factory method to create a fixed size list.- Type Parameters:
E- the type of the elements in the list- Parameters:
list- the list to decorate, must not be null- Returns:
- a new fixed size list
- Throws:
NullPointerException- if list is null- Since:
- 4.0
-
add
-
add
-
addAll
- Specified by:
addAllin interfaceCollection<E>- Specified by:
addAllin interfaceList<E>- Overrides:
addAllin classAbstractCollectionDecorator<E>
-
addAll
-
clear
- Specified by:
clearin interfaceCollection<E>- Specified by:
clearin interfaceList<E>- Overrides:
clearin classAbstractCollectionDecorator<E>
-
get
-
indexOf
-
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
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceList<E>- Overrides:
lastIndexOfin classAbstractListDecorator<E>
-
listIterator
- Specified by:
listIteratorin interfaceList<E>- Overrides:
listIteratorin classAbstractListDecorator<E>
-
listIterator
- Specified by:
listIteratorin interfaceList<E>- Overrides:
listIteratorin classAbstractListDecorator<E>
-
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
-
remove
-
removeAll
- Specified by:
removeAllin interfaceCollection<E>- Specified by:
removeAllin interfaceList<E>- Overrides:
removeAllin classAbstractCollectionDecorator<E>
-
removeIf
- Specified by:
removeIfin interfaceCollection<E>- Overrides:
removeIfin classAbstractCollectionDecorator<E>- Since:
- 4.4
-
retainAll
- Specified by:
retainAllin interfaceCollection<E>- Specified by:
retainAllin interfaceList<E>- Overrides:
retainAllin classAbstractCollectionDecorator<E>
-
set
-
subList
-