FixedSizeList (The Adobe AEM Quickstart and Web Application.)

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:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.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:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E object)`
`void`	`add(int index, E object)`
`boolean`	`addAll(java.util.Collection<? extends E> coll)`
`boolean`	`addAll(int index, java.util.Collection<? extends E> coll)`
`void`	`clear()`
`static <E> FixedSizeList<E>`	`fixedSizeList(java.util.List<E> list)` Factory method to create a fixed size list.
`E`	`get(int index)`
`int`	`indexOf(java.lang.Object object)`
`boolean`	`isFull()` Returns true if this collection is full and no new elements can be added.
`java.util.Iterator<E>`	`iterator()`
`int`	`lastIndexOf(java.lang.Object object)`
`java.util.ListIterator<E>`	`listIterator()`
`java.util.ListIterator<E>`	`listIterator(int index)`
`int`	`maxSize()` Gets the maximum size of the collection (the bound).
`E`	`remove(int index)`
`boolean`	`remove(java.lang.Object object)`
`boolean`	`removeAll(java.util.Collection<?> coll)`
`boolean`	`removeIf(java.util.function.Predicate<? super E> filter)`
`boolean`	`retainAll(java.util.Collection<?> coll)`
`E`	`set(int index, E object)`
`java.util.List<E>`	`subList(int fromIndex, int toIndex)`

Methods inherited from class org.apache.commons.collections4.list.AbstractListDecorator
equals, hashCode

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
contains, containsAll, equals, hashCode, isEmpty, parallelStream, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
contains, containsAll, isEmpty, replaceAll, size, sort, spliterator, toArray, toArray

- Method Detail
  - fixedSizeList
```
public static <E> FixedSizeList<E> fixedSizeList(java.util.List<E> list)
```
    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:
    
    java.lang.NullPointerException - if list is null
    
    Since:
    
    4.0
  - add
```
public boolean add(E object)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class AbstractCollectionDecorator<E>
  - add
```
public void add(int index,
                E object)
```
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class AbstractListDecorator<E>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> coll)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
    
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class AbstractCollectionDecorator<E>
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection<? extends E> coll)
```
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class AbstractListDecorator<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
    
    Overrides:
    
    clear in class AbstractCollectionDecorator<E>
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface java.util.List<E>
    
    Overrides:
    
    get in class AbstractListDecorator<E>
  - indexOf
```
public int indexOf(java.lang.Object object)
```
    Specified by:
    
    indexOf in interface java.util.List<E>
    
    Overrides:
    
    indexOf in class AbstractListDecorator<E>
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
    
    Overrides:
    
    iterator in class AbstractCollectionDecorator<E>
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object object)
```
    Specified by:
    
    lastIndexOf in interface java.util.List<E>
    
    Overrides:
    
    lastIndexOf in class AbstractListDecorator<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class AbstractListDecorator<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class AbstractListDecorator<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class AbstractListDecorator<E>
  - remove
```
public boolean remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class AbstractCollectionDecorator<E>
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super E> filter)
```
    Specified by:
    
    removeIf in interface java.util.Collection<E>
    
    Overrides:
    
    removeIf in class AbstractCollectionDecorator<E>
    
    Since:
    
    4.4
  - removeAll
```
public boolean removeAll(java.util.Collection<?> coll)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E>
    
    Specified by:
    
    removeAll in interface java.util.List<E>
    
    Overrides:
    
    removeAll in class AbstractCollectionDecorator<E>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> coll)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E>
    
    Specified by:
    
    retainAll in interface java.util.List<E>
    
    Overrides:
    
    retainAll in class AbstractCollectionDecorator<E>
  - set
```
public E set(int index,
             E object)
```
    Specified by:
    
    set in interface java.util.List<E>
    
    Overrides:
    
    set in class AbstractListDecorator<E>
  - subList
```
public java.util.List<E> subList(int fromIndex,
                                 int toIndex)
```
    Specified by:
    
    subList in interface java.util.List<E>
    
    Overrides:
    
    subList in class AbstractListDecorator<E>
  - 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 interface BoundedCollection<E>
    
    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 interface BoundedCollection<E>
    
    Returns:
    
    the maximum number of elements the collection can hold.

Class FixedSizeList<E>

Method Summary

Methods inherited from class org.apache.commons.collections4.list.AbstractListDecorator

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Method Detail

fixedSizeList

add

add

addAll

addAll

clear

get

indexOf

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeIf

removeAll

retainAll

set

subList

isFull

maxSize