org.apache.commons.collections4.list

## 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>

- 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
  Version:
    $Id: FixedSizeList.java 1479405 2013-05-05 21:58:52Z tn $
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `FixedSizeList(List<E> list)` Constructor that wraps (not copies).

  - ### Method Summary

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

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

      `decorated`

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

      `contains, containsAll, equals, hashCode, isEmpty, setCollection, 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

      `contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray`

    - ### Methods inherited from interface java.util.List

      `contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray`

- - ### Constructor Detail

    - #### FixedSizeList

          protected FixedSizeList(List<E> list)

      Constructor that wraps (not copies).
      Parameters:
        `list` - the list to decorate, must not be null
      Throws:
        `IllegalArgumentException` - if list is null

  - ### Method Detail

    - #### fixedSizeList

          public static <E> FixedSizeList<E> fixedSizeList(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:
        `IllegalArgumentException` - if list is null
      Since:
        4.0

    - #### add

          public boolean add(E object)

      Specified by:
        `add` in interface `Collection<E>`
      Specified by:
        `add` in interface `List<E>`
      Overrides:
        `add` in class `AbstractCollectionDecorator<E>`

    - #### add

          public void add(int index,
                 E object)

      Specified by:
        `add` in interface `List<E>`
      Overrides:
        `add` in class `AbstractListDecorator<E>`

    - #### addAll

          public boolean addAll(Collection<? extends E> coll)

      Specified by:
        `addAll` in interface `Collection<E>`
      Specified by:
        `addAll` in interface `List<E>`
      Overrides:
        `addAll` in class `AbstractCollectionDecorator<E>`

    - #### addAll

          public boolean addAll(int index,
                       Collection<? extends E> coll)

      Specified by:
        `addAll` in interface `List<E>`
      Overrides:
        `addAll` in class `AbstractListDecorator<E>`

    - #### clear

          public void clear()

      Specified by:
        `clear` in interface `Collection<E>`
      Specified by:
        `clear` in interface `List<E>`
      Overrides:
        `clear` in class `AbstractCollectionDecorator<E>`

    - #### get

          public E get(int index)

      Specified by:
        `get` in interface `List<E>`
      Overrides:
        `get` in class `AbstractListDecorator<E>`

    - #### indexOf

          public int indexOf(Object object)

      Specified by:
        `indexOf` in interface `List<E>`
      Overrides:
        `indexOf` in class `AbstractListDecorator<E>`

    - #### iterator

          public Iterator<E> iterator()

      Specified by:
        `iterator` in interface `Iterable<E>`
      Specified by:
        `iterator` in interface `Collection<E>`
      Specified by:
        `iterator` in interface `List<E>`
      Overrides:
        `iterator` in class `AbstractCollectionDecorator<E>`

    - #### lastIndexOf

          public int lastIndexOf(Object object)

      Specified by:
        `lastIndexOf` in interface `List<E>`
      Overrides:
        `lastIndexOf` in class `AbstractListDecorator<E>`

    - #### listIterator

          public ListIterator<E> listIterator()

      Specified by:
        `listIterator` in interface `List<E>`
      Overrides:
        `listIterator` in class `AbstractListDecorator<E>`

    - #### listIterator

          public ListIterator<E> listIterator(int index)

      Specified by:
        `listIterator` in interface `List<E>`
      Overrides:
        `listIterator` in class `AbstractListDecorator<E>`

    - #### remove

          public E remove(int index)

      Specified by:
        `remove` in interface `List<E>`
      Overrides:
        `remove` in class `AbstractListDecorator<E>`

    - #### remove

          public boolean remove(Object object)

      Specified by:
        `remove` in interface `Collection<E>`
      Specified by:
        `remove` in interface `List<E>`
      Overrides:
        `remove` in class `AbstractCollectionDecorator<E>`

    - #### removeAll

          public boolean removeAll(Collection<?> coll)

      Specified by:
        `removeAll` in interface `Collection<E>`
      Specified by:
        `removeAll` in interface `List<E>`
      Overrides:
        `removeAll` in class `AbstractCollectionDecorator<E>`

    - #### retainAll

          public boolean retainAll(Collection<?> coll)

      Specified by:
        `retainAll` in interface `Collection<E>`
      Specified by:
        `retainAll` in interface `List<E>`
      Overrides:
        `retainAll` in class `AbstractCollectionDecorator<E>`

    - #### set

          public E set(int index,
              E object)

      Specified by:
        `set` in interface `List<E>`
      Overrides:
        `set` in class `AbstractListDecorator<E>`

    - #### subList

          public List<E> subList(int fromIndex,
                        int toIndex)

      Specified by:
        `subList` in interface `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

Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.