Class FixedSizeList
- java.lang.Object
-
- org.apache.commons.collections.collection.AbstractCollectionDecorator
-
- org.apache.commons.collections.list.AbstractListDecorator
-
- org.apache.commons.collections.list.AbstractSerializableListDecorator
-
- org.apache.commons.collections.list.FixedSizeList
-
- All Implemented Interfaces:
Serializable
,Iterable
,Collection
,List
,BoundedCollection
public class FixedSizeList extends AbstractSerializableListDecorator implements BoundedCollection
Decorates anotherList
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:
- Commons Collections 3.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Stephen Colebourne, Paul Jack
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FixedSizeList(List list)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(int index, Object object)
boolean
add(Object object)
boolean
addAll(int index, Collection coll)
boolean
addAll(Collection coll)
void
clear()
static List
decorate(List list)
Factory method to create a fixed size list.Object
get(int index)
int
indexOf(Object object)
boolean
isFull()
Returns true if this collection is full and no new elements can be added.Iterator
iterator()
int
lastIndexOf(Object object)
ListIterator
listIterator()
ListIterator
listIterator(int index)
int
maxSize()
Gets the maximum size of the collection (the bound).Object
remove(int index)
boolean
remove(Object object)
boolean
removeAll(Collection coll)
boolean
retainAll(Collection coll)
Object
set(int index, Object object)
List
subList(int fromIndex, int toIndex)
-
Methods inherited from class org.apache.commons.collections.list.AbstractListDecorator
getList
-
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
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface java.util.List
contains, containsAll, equals, hashCode, isEmpty, replaceAll, size, sort, spliterator, toArray, toArray
-
-
-
-
Constructor Detail
-
FixedSizeList
protected FixedSizeList(List list)
Constructor that wraps (not copies).- Parameters:
list
- the list to decorate, must not be null- Throws:
IllegalArgumentException
- if list is null
-
-
Method Detail
-
decorate
public static List decorate(List list)
Factory method to create a fixed size list.- Parameters:
list
- the list to decorate, must not be null- Throws:
IllegalArgumentException
- if list is null
-
add
public boolean add(Object object)
- Specified by:
add
in interfaceCollection
- Specified by:
add
in interfaceList
- Overrides:
add
in classAbstractCollectionDecorator
-
add
public void add(int index, Object object)
- Specified by:
add
in interfaceList
- Overrides:
add
in classAbstractListDecorator
-
addAll
public boolean addAll(Collection coll)
- Specified by:
addAll
in interfaceCollection
- Specified by:
addAll
in interfaceList
- Overrides:
addAll
in classAbstractCollectionDecorator
-
addAll
public boolean addAll(int index, Collection coll)
- Specified by:
addAll
in interfaceList
- Overrides:
addAll
in classAbstractListDecorator
-
clear
public void clear()
- Specified by:
clear
in interfaceCollection
- Specified by:
clear
in interfaceList
- Overrides:
clear
in classAbstractCollectionDecorator
-
get
public Object get(int index)
- Specified by:
get
in interfaceList
- Overrides:
get
in classAbstractListDecorator
-
indexOf
public int indexOf(Object object)
- Specified by:
indexOf
in interfaceList
- Overrides:
indexOf
in classAbstractListDecorator
-
iterator
public Iterator iterator()
- Specified by:
iterator
in interfaceCollection
- Specified by:
iterator
in interfaceIterable
- Specified by:
iterator
in interfaceList
- Overrides:
iterator
in classAbstractCollectionDecorator
-
lastIndexOf
public int lastIndexOf(Object object)
- Specified by:
lastIndexOf
in interfaceList
- Overrides:
lastIndexOf
in classAbstractListDecorator
-
listIterator
public ListIterator listIterator()
- Specified by:
listIterator
in interfaceList
- Overrides:
listIterator
in classAbstractListDecorator
-
listIterator
public ListIterator listIterator(int index)
- Specified by:
listIterator
in interfaceList
- Overrides:
listIterator
in classAbstractListDecorator
-
remove
public Object remove(int index)
- Specified by:
remove
in interfaceList
- Overrides:
remove
in classAbstractListDecorator
-
remove
public boolean remove(Object object)
- Specified by:
remove
in interfaceCollection
- Specified by:
remove
in interfaceList
- Overrides:
remove
in classAbstractCollectionDecorator
-
removeAll
public boolean removeAll(Collection coll)
- Specified by:
removeAll
in interfaceCollection
- Specified by:
removeAll
in interfaceList
- Overrides:
removeAll
in classAbstractCollectionDecorator
-
retainAll
public boolean retainAll(Collection coll)
- Specified by:
retainAll
in interfaceCollection
- Specified by:
retainAll
in interfaceList
- Overrides:
retainAll
in classAbstractCollectionDecorator
-
set
public Object set(int index, Object object)
- Specified by:
set
in interfaceList
- Overrides:
set
in classAbstractListDecorator
-
subList
public List subList(int fromIndex, int toIndex)
- Specified by:
subList
in interfaceList
- Overrides:
subList
in classAbstractListDecorator
-
isFull
public boolean 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
- Returns:
true
if the collection is full
-
maxSize
public int maxSize()
Description copied from interface:BoundedCollection
Gets the maximum size of the collection (the bound).- Specified by:
maxSize
in interfaceBoundedCollection
- Returns:
- the maximum number of elements the collection can hold
-
-