Package org.apache.commons.collections

Class CursorableSubList

java.lang.Object
org.apache.commons.collections.CursorableLinkedList
org.apache.commons.collections.CursorableSubList
All Implemented Interfaces:
Serializable, Iterable, Collection, List
class CursorableSubList extends CursorableLinkedList implements List
Deprecated.
Use new version in list subpackage, which has been rewritten and now returns the cursor from the listIterator method. Will be removed in v4.0

  • Field Details

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes all of the elements from this list. This list will be empty after this call returns (unless it throws an exception).
      Specified by:
      clear in interface Collection
      Specified by:
      clear in interface List
      Overrides:
      clear in class CursorableLinkedList

    • iterator

      public Iterator iterator()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns a fail-fast iterator.
      Specified by:
      iterator in interface Collection
      Specified by:
      iterator in interface Iterable
      Specified by:
      iterator in interface List
      Overrides:
      iterator in class CursorableLinkedList
      See Also:

    • size

      public int size()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the number of elements in this list.
      Specified by:
      size in interface Collection
      Specified by:
      size in interface List
      Overrides:
      size in class CursorableLinkedList
      Returns:
      the number of elements in this list.

    • isEmpty

      public boolean isEmpty()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns true if this list contains no elements.
      Specified by:
      isEmpty in interface Collection
      Specified by:
      isEmpty in interface List
      Overrides:
      isEmpty in class CursorableLinkedList
      Returns:
      true if this list contains no elements.

    • toArray

      public Object[] toArray()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray() method.
      Specified by:
      toArray in interface Collection
      Specified by:
      toArray in interface List
      Overrides:
      toArray in class CursorableLinkedList
      Returns:
      an array containing all of the elements in this list in proper sequence.

    • toArray

      public Object[] toArray(Object[] a)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray() method.
      Specified by:
      toArray in interface Collection
      Specified by:
      toArray in interface List
      Overrides:
      toArray in class CursorableLinkedList
      Parameters:
      a - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
      Returns:
      an array containing the elements of this list.

    • contains

      public boolean contains(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
      Specified by:
      contains in interface Collection
      Specified by:
      contains in interface List
      Overrides:
      contains in class CursorableLinkedList
      Parameters:
      o - element whose presence in this list is to be tested.
      Returns:
      true if this list contains the specified element.

    • remove

      public boolean remove(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes the first occurrence in this list of the specified element. If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists).
      Specified by:
      remove in interface Collection
      Specified by:
      remove in interface List
      Overrides:
      remove in class CursorableLinkedList
      Parameters:
      o - element to be removed from this list, if present.
      Returns:
      true if this list contained the specified element.

    • removeFirst

      public Object removeFirst()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes the first element of this list, if any.
      Overrides:
      removeFirst in class CursorableLinkedList

    • removeLast

      public Object removeLast()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes the last element of this list, if any.
      Overrides:
      removeLast in class CursorableLinkedList

    • addAll

      public boolean addAll(Collection c)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Specified by:
      addAll in interface Collection
      Specified by:
      addAll in interface List
      Overrides:
      addAll in class CursorableLinkedList
      Parameters:
      c - collection whose elements are to be added to this list.
      Returns:
      true if this list changed as a result of the call.

    • add

      public boolean add(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Appends the specified element to the end of this list.
      Specified by:
      add in interface Collection
      Specified by:
      add in interface List
      Overrides:
      add in class CursorableLinkedList
      Parameters:
      o - element to be appended to this list.
      Returns:
      true

    • addFirst

      public boolean addFirst(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Inserts the specified element at the beginning of this list. (Equivalent to add(0,o)).
      Overrides:
      addFirst in class CursorableLinkedList
      Parameters:
      o - element to be prepended to this list.
      Returns:
      true

    • addLast

      public boolean addLast(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Inserts the specified element at the end of this list. (Equivalent to CursorableLinkedList.add(java.lang.Object)).
      Overrides:
      addLast in class CursorableLinkedList
      Parameters:
      o - element to be appended to this list.
      Returns:
      true

    • removeAll

      public boolean removeAll(Collection c)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes from this list all the elements that are contained in the specified collection.
      Specified by:
      removeAll in interface Collection
      Specified by:
      removeAll in interface List
      Overrides:
      removeAll in class CursorableLinkedList
      Parameters:
      c - collection that defines which elements will be removed from this list.
      Returns:
      true if this list changed as a result of the call.

    • containsAll

      public boolean containsAll(Collection c)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns true if this list contains all of the elements of the specified collection.
      Specified by:
      containsAll in interface Collection
      Specified by:
      containsAll in interface List
      Overrides:
      containsAll in class CursorableLinkedList
      Parameters:
      c - collection to be checked for containment in this list.
      Returns:
      true if this list contains all of the elements of the specified collection.

    • addAll

      public boolean addAll(int index, Collection c)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Inserts all of the elements in the specified collection into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Specified by:
      addAll in interface List
      Overrides:
      addAll in class CursorableLinkedList
      Parameters:
      index - index at which to insert first element from the specified collection.
      c - elements to be inserted into this list.
      Returns:
      true if this list changed as a result of the call.

    • hashCode

      public int hashCode()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation: 
        hashCode = 1;
  Iterator i = list.iterator();
  while (i.hasNext()) {
      Object obj = i.next();
      hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
  }
      This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode.
      Specified by:
      hashCode in interface Collection
      Specified by:
      hashCode in interface List
      Overrides:
      hashCode in class CursorableLinkedList
      Returns:
      the hash code value for this list.
      See Also:

    • retainAll

      public boolean retainAll(Collection c)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all the elements that are not contained in the specified collection.
      Specified by:
      retainAll in interface Collection
      Specified by:
      retainAll in interface List
      Overrides:
      retainAll in class CursorableLinkedList
      Parameters:
      c - collection that defines which elements this set will retain.
      Returns:
      true if this list changed as a result of the call.

    • set

      public Object set(int index, Object element)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Replaces the element at the specified position in this list with the specified element.
      Specified by:
      set in interface List
      Overrides:
      set in class CursorableLinkedList
      Parameters:
      index - index of element to replace.
      element - element to be stored at the specified position.
      Returns:
      the element previously at the specified position.

    • equals

      public boolean equals(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface.
      Specified by:
      equals in interface Collection
      Specified by:
      equals in interface List
      Overrides:
      equals in class CursorableLinkedList
      Parameters:
      o - the object to be compared for equality with this list.
      Returns:
      true if the specified object is equal to this list.

    • get

      public Object get(int index)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the element at the specified position in this list.
      Specified by:
      get in interface List
      Overrides:
      get in class CursorableLinkedList
      Parameters:
      index - index of element to return.
      Returns:
      the element at the specified position in this list.

    • getFirst

      public Object getFirst()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the element at the beginning of this list.
      Overrides:
      getFirst in class CursorableLinkedList

    • getLast

      public Object getLast()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the element at the end of this list.
      Overrides:
      getLast in class CursorableLinkedList

    • add

      public void add(int index, Object element)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
      Specified by:
      add in interface List
      Overrides:
      add in class CursorableLinkedList
      Parameters:
      index - index at which the specified element is to be inserted.
      element - element to be inserted.

    • listIterator

      public ListIterator listIterator(int index)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns a fail-fast ListIterator.
      Specified by:
      listIterator in interface List
      Overrides:
      listIterator in class CursorableLinkedList
      See Also:

    • remove

      public Object remove(int index)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
      Specified by:
      remove in interface List
      Overrides:
      remove in class CursorableLinkedList
      Parameters:
      index - the index of the element to removed.
      Returns:
      the element previously at the specified position.

    • indexOf

      public int indexOf(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
      Specified by:
      indexOf in interface List
      Overrides:
      indexOf in class CursorableLinkedList
      Parameters:
      o - element to search for.
      Returns:
      the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.

    • lastIndexOf

      public int lastIndexOf(Object o)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
      Specified by:
      lastIndexOf in interface List
      Overrides:
      lastIndexOf in class CursorableLinkedList
      Parameters:
      o - element to search for.
      Returns:
      the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

    • listIterator

      public ListIterator listIterator()
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns a fail-fast ListIterator.
      Specified by:
      listIterator in interface List
      Overrides:
      listIterator in class CursorableLinkedList
      See Also:

    • subList

      public List subList(int fromIndex, int toIndex)
      Deprecated.
      Description copied from class: CursorableLinkedList
      Returns a fail-fast sublist.
      Specified by:
      subList in interface List
      Overrides:
      subList in class CursorableLinkedList
      See Also:

    • insertListable

      protected CursorableLinkedList.Listable insertListable(CursorableLinkedList.Listable before, CursorableLinkedList.Listable after, Object value)
      Deprecated.
      Inserts a new value into my list, after the specified before element, and before the specified after element
      Overrides:
      insertListable in class CursorableLinkedList
      Returns:
      the newly created CursorableLinkedList.Listable

    • removeListable

      protected void removeListable(CursorableLinkedList.Listable elt)
      Deprecated.
      Removes the given CursorableLinkedList.Listable from my list.
      Overrides:
      removeListable in class CursorableLinkedList

    • checkForComod

      protected void checkForComod() throws ConcurrentModificationException
      Deprecated.
      Test to see if my underlying list has been modified by some other process. If it has, throws a ConcurrentModificationException, otherwise quietly returns.
      Throws:
      ConcurrentModificationException