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).
This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FixedSizeList
(List<E> list) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
boolean
boolean
addAll
(int index, Collection<? extends E> coll) boolean
addAll
(Collection<? extends E> coll) void
clear()
static <E> FixedSizeList<E>
fixedSizeList
(List<E> list) Factory method to create a fixed size list.get
(int index) int
boolean
isFull()
Returns true if this collection is full and no new elements can be added.iterator()
int
lastIndexOf
(Object object) listIterator
(int index) int
maxSize()
Gets the maximum size of the collection (the bound).remove
(int index) boolean
boolean
removeAll
(Collection<?> coll) boolean
retainAll
(Collection<?> coll) subList
(int fromIndex, int toIndex) Methods inherited from class org.apache.commons.collections4.list.AbstractListDecorator
decorated, equals, hashCode
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toString
-
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
- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceList<E>
- Overrides:
add
in classAbstractCollectionDecorator<E>
-
add
-
addAll
- Specified by:
addAll
in interfaceCollection<E>
- Specified by:
addAll
in interfaceList<E>
- Overrides:
addAll
in classAbstractCollectionDecorator<E>
-
addAll
-
clear
- Specified by:
clear
in interfaceCollection<E>
- Specified by:
clear
in interfaceList<E>
- Overrides:
clear
in classAbstractCollectionDecorator<E>
-
get
-
indexOf
-
iterator
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceList<E>
- Overrides:
lastIndexOf
in classAbstractListDecorator<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classAbstractListDecorator<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
- Overrides:
listIterator
in classAbstractListDecorator<E>
-
remove
-
remove
- Specified by:
remove
in interfaceCollection<E>
- Specified by:
remove
in interfaceList<E>
- Overrides:
remove
in classAbstractCollectionDecorator<E>
-
removeAll
- Specified by:
removeAll
in interfaceCollection<E>
- Specified by:
removeAll
in interfaceList<E>
- Overrides:
removeAll
in classAbstractCollectionDecorator<E>
-
retainAll
- Specified by:
retainAll
in interfaceCollection<E>
- Specified by:
retainAll
in interfaceList<E>
- Overrides:
retainAll
in classAbstractCollectionDecorator<E>
-
set
-
subList
-
isFull
Description copied from interface:BoundedCollection
Returns true if this collection is full and no new elements can be added.- Specified by:
isFull
in interfaceBoundedCollection<E>
- Returns:
true
if the collection is full
-
maxSize
Description copied from interface:BoundedCollection
Gets the maximum size of the collection (the bound).- Specified by:
maxSize
in interfaceBoundedCollection<E>
- Returns:
- the maximum number of elements the collection can hold
-