Package org.apache.commons.collections.list

Class FixedSizeList

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.List, BoundedCollection
    @Deprecated(since="2021-04-30")
public class FixedSizeList
extends AbstractSerializableListDecorator
implements BoundedCollection
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
    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:
    Commons Collections 3.0
    See Also:
    Serialized Form

    • Method Summary

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.List

        contains, containsAll, equals, hashCode, isEmpty, replaceAll, size, sort, spliterator, toArray, toArray

    • Method Detail

      • decorate

        public static java.util.List decorate​(java.util.List list)
        Deprecated.
        Factory method to create a fixed size list.
        Parameters:
        list - the list to decorate, must not be null
        Throws:
        java.lang.IllegalArgumentException - if list is null

      • add

        public boolean add​(java.lang.Object object)
        Deprecated.
        Specified by:
        add in interface java.util.Collection
        Specified by:
        add in interface java.util.List
        Overrides:
        add in class AbstractCollectionDecorator

      • add

        public void add​(int index,
                java.lang.Object object)
        Deprecated.
        Specified by:
        add in interface java.util.List
        Overrides:
        add in class AbstractListDecorator

      • addAll

        public boolean addAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        addAll in interface java.util.Collection
        Specified by:
        addAll in interface java.util.List
        Overrides:
        addAll in class AbstractCollectionDecorator

      • addAll

        public boolean addAll​(int index,
                      java.util.Collection coll)
        Deprecated.
        Specified by:
        addAll in interface java.util.List
        Overrides:
        addAll in class AbstractListDecorator

      • clear

        public void clear()
        Deprecated.
        Specified by:
        clear in interface java.util.Collection
        Specified by:
        clear in interface java.util.List
        Overrides:
        clear in class AbstractCollectionDecorator

      • get

        public java.lang.Object get​(int index)
        Deprecated.
        Specified by:
        get in interface java.util.List
        Overrides:
        get in class AbstractListDecorator

      • indexOf

        public int indexOf​(java.lang.Object object)
        Deprecated.
        Specified by:
        indexOf in interface java.util.List
        Overrides:
        indexOf in class AbstractListDecorator

      • iterator

        public java.util.Iterator iterator()
        Deprecated.
        Specified by:
        iterator in interface java.util.Collection
        Specified by:
        iterator in interface java.lang.Iterable
        Specified by:
        iterator in interface java.util.List
        Overrides:
        iterator in class AbstractCollectionDecorator

      • lastIndexOf

        public int lastIndexOf​(java.lang.Object object)
        Deprecated.
        Specified by:
        lastIndexOf in interface java.util.List
        Overrides:
        lastIndexOf in class AbstractListDecorator

      • listIterator

        public java.util.ListIterator listIterator()
        Deprecated.
        Specified by:
        listIterator in interface java.util.List
        Overrides:
        listIterator in class AbstractListDecorator

      • listIterator

        public java.util.ListIterator listIterator​(int index)
        Deprecated.
        Specified by:
        listIterator in interface java.util.List
        Overrides:
        listIterator in class AbstractListDecorator

      • remove

        public java.lang.Object remove​(int index)
        Deprecated.
        Specified by:
        remove in interface java.util.List
        Overrides:
        remove in class AbstractListDecorator

      • remove

        public boolean remove​(java.lang.Object object)
        Deprecated.
        Specified by:
        remove in interface java.util.Collection
        Specified by:
        remove in interface java.util.List
        Overrides:
        remove in class AbstractCollectionDecorator

      • removeAll

        public boolean removeAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        removeAll in interface java.util.Collection
        Specified by:
        removeAll in interface java.util.List
        Overrides:
        removeAll in class AbstractCollectionDecorator

      • retainAll

        public boolean retainAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        retainAll in interface java.util.Collection
        Specified by:
        retainAll in interface java.util.List
        Overrides:
        retainAll in class AbstractCollectionDecorator

      • set

        public java.lang.Object set​(int index,
                            java.lang.Object object)
        Deprecated.
        Specified by:
        set in interface java.util.List
        Overrides:
        set in class AbstractListDecorator

      • subList

        public java.util.List subList​(int fromIndex,
                              int toIndex)
        Deprecated.
        Specified by:
        subList in interface java.util.List
        Overrides:
        subList in class AbstractListDecorator

      • isFull

        public boolean isFull()
        Deprecated.
        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
        Returns:
        true if the collection is full

      • maxSize

        public int maxSize()
        Deprecated.
        Description copied from interface: BoundedCollection
        Gets the maximum size of the collection (the bound).
        Specified by:
        maxSize in interface BoundedCollection
        Returns:
        the maximum number of elements the collection can hold