Package org.apache.pivot.collections

Class LinkedList<T>

  • Type Parameters:
    T - The type of object stored in the list.
    All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<T>, Collection<T>, List<T>, Sequence<T>
    public class LinkedList<T>
extends java.lang.Object
implements List<T>, java.io.Serializable
    Implementation of the List interface that is backed by a linked list.

    NOTE This class is not thread-safe. For concurrent access, use a SynchronizedList.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int add​(T item)
      Adds an item to the list.
      void clear()
      Removes all elements from the collection.
      boolean equals​(java.lang.Object o)  
      T get​(int index)
      Retrieves the item at the given index.
      java.util.Comparator<T> getComparator()
      Returns the collection's sort order.
      int getLength()
      Returns the length of the list.
      ListenerList<ListListener<T>> getListListeners()
      Returns the list listener list.
      int hashCode()  
      int indexOf​(T item)
      Returns the index of an item in the sequence.
      void insert​(T item, int index)
      Inserts an item into the list.
      boolean isEmpty()
      Tests the emptiness of the collection.
      List.ItemIterator<T> iterator()  
      Sequence<T> remove​(int index, int count)
      Removes one or more items from the sequence.
      int remove​(T item)
      Removes the first occurrence of the given item from the sequence.
      void setComparator​(java.util.Comparator<T> comparator)
      Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.
      java.lang.String toString()  
      T update​(int index, T item)
      Updates the item at the given index.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • LinkedList

        public LinkedList()

      • LinkedList

        public LinkedList​(java.util.Comparator<T> comparator)

      • LinkedList

        @SafeVarargs
public LinkedList​(T... items)

      • LinkedList

        public LinkedList​(Sequence<T> items)

    • Method Detail

      • add

        public int add​(T item)
        Description copied from interface: List
        Adds an item to the list. If the list is unsorted, the item is appended to the end of the list. Otherwise, it is inserted at the appropriate index.
        Specified by:
        add in interface List<T>
        Specified by:
        add in interface Sequence<T>
        Parameters:
        item - The item to be added to the sequence.
        Returns:
        The index at which the item was added.
        See Also:
        ListListener.itemInserted(List, int)

      • insert

        public void insert​(T item,
                   int index)
        Description copied from interface: List
        Inserts an item into the list.
        Specified by:
        insert in interface List<T>
        Specified by:
        insert in interface Sequence<T>
        Parameters:
        item - The item to be added to the list.
        index - The index at which the item should be inserted. Must be a value between 0 and getLength().
        See Also:
        ListListener.itemInserted(List, int)

      • update

        public T update​(int index,
                T item)
        Description copied from interface: List
        Updates the item at the given index.
        Specified by:
        update in interface List<T>
        Specified by:
        update in interface Sequence<T>
        Parameters:
        index - The index of the item to update.
        item - The item that will replace any existing value at the given index.
        Returns:
        The item that was previously stored at the given index.
        See Also:
        ListListener.itemUpdated(List, int, Object)

      • remove

        public int remove​(T item)
        Description copied from interface: Sequence
        Removes the first occurrence of the given item from the sequence.
        Specified by:
        remove in interface Sequence<T>
        Parameters:
        item - The item to remove.
        Returns:
        The index of the item that was removed, or -1 if the item could not be found.
        See Also:
        Sequence.remove(int, int)

      • remove

        public Sequence<T> remove​(int index,
                          int count)
        Description copied from interface: Sequence
        Removes one or more items from the sequence.
        Specified by:
        remove in interface List<T>
        Specified by:
        remove in interface Sequence<T>
        Parameters:
        index - The starting index to remove.
        count - The number of items to remove, beginning with index.
        Returns:
        A sequence containing the items that were removed.
        See Also:
        ListListener.itemsRemoved(List, int, Sequence)

      • get

        public T get​(int index)
        Description copied from interface: Sequence
        Retrieves the item at the given index.
        Specified by:
        get in interface Sequence<T>
        Parameters:
        index - The index of the item to retrieve.
        Returns:
        The item at this index in the sequence.

      • indexOf

        public int indexOf​(T item)
        Description copied from interface: Sequence
        Returns the index of an item in the sequence.
        Specified by:
        indexOf in interface Sequence<T>
        Parameters:
        item - The item to locate.
        Returns:
        The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Collection
        Tests the emptiness of the collection.
        Specified by:
        isEmpty in interface Collection<T>
        Returns:
        true if the collection contains no elements; false, otherwise.

      • getLength

        public int getLength()
        Description copied from interface: List
        Returns the length of the list.
        Specified by:
        getLength in interface List<T>
        Specified by:
        getLength in interface Sequence<T>
        Returns:
        The number of items in the list, or -1 if the list's length is not known. In this case, the iterator must be used to retrieve the contents of the list.

      • getComparator

        public java.util.Comparator<T> getComparator()
        Description copied from interface: Collection
        Returns the collection's sort order.
        Specified by:
        getComparator in interface Collection<T>
        Returns:
        The comparator used to order elements in the collection, or null if the sort order is undefined.
        See Also:
        Collection.setComparator(Comparator)

      • setComparator

        public void setComparator​(java.util.Comparator<T> comparator)
        Description copied from interface: Collection
        Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

        Calling this method more than once with the same comparator will re-sort the collection.

        Specified by:
        setComparator in interface Collection<T>
        Specified by:
        setComparator in interface List<T>
        Parameters:
        comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.
        See Also:
        ListListener.comparatorChanged(List, Comparator)

      • iterator

        public List.ItemIterator<T> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<T>

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object