E - the type of elements in this list
Iterable<E>, Collection<E>, List<E>
AbstractSequentialList, ArrayList, Vector
This class provides a skeletal implementation of the
List
interface to minimize the effort required to implement this interface backed by a "random access" data store (such as an array). For sequential access data (such as a linked list),
AbstractSequentialList
should be used in preference to this class.
To implement an unmodifiable list, the programmer needs only to extend this class and provide implementations for the get(int) and size() methods.
To implement a modifiable list, the programmer must additionally override the set(int, E) method (which otherwise throws an UnsupportedOperationException). If the list is variable-size the programmer must additionally override the add(int, E) and remove(int) methods.
The programmer should generally provide a void (no argument) and collection constructor, as per the recommendation in the Collection interface specification.
Unlike the other abstract collection implementations, the programmer does not have to provide an iterator implementation; the iterator and list iterator are implemented by this class, on top of the "random access" methods: get(int), set(int, E), add(int, E) and remove(int).
The documentation for each non-abstract method in this class describes its implementation in detail. Each of these methods may be overridden if the collection being implemented admits a more efficient implementation.
This class is a member of the Java Collections Framework.
Fields
protected int
The number of times this list has been structurally modified.
Constructors
void
add(int index, E element)
Inserts the specified element at the specified position in this list (optional operation).
boolean
Appends the specified element to the end of this list (optional operation).
boolean
Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void
Removes all of the elements from this list (optional operation).
boolean
Compares the specified object with this list for equality.
Returns the element at the specified position in this list.
int
Returns the hash code value for this list.
int
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
Returns an iterator over the elements in this list in proper sequence.
int
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
Returns a list iterator over the elements in this list (in proper sequence).
Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
Removes the element at the specified position in this list (optional operation).
protected void
Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
set(int index, E element)
Replaces the element at the specified position in this list with the specified element (optional operation).
subList(int fromIndex, int toIndex)
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArrayprotected transient int modCount
The number of times this list has been
structurally modified. Structural modifications are those that change the size of the list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.
This field is used by the iterator and list iterator implementation returned by the iterator and listIterator methods. If the value of this field changes unexpectedly, the iterator (or list iterator) will throw a ConcurrentModificationException in response to the next, remove, previous, set or add operations. This provides fail-fast behavior, rather than non-deterministic behavior in the face of concurrent modification during iteration.
Use of this field by subclasses is optional. If a subclass wishes to provide fail-fast iterators (and list iterators), then it merely has to increment this field in its add(int, E) and remove(int) methods (and any other methods that it overrides that result in structural modifications to the list). A single call to add(int, E) or remove(int) must add no more than one to this field, or the iterators (and list iterators) will throw bogus ConcurrentModificationExceptions. If an implementation does not wish to provide fail-fast iterators, this field may be ignored.
protected AbstractList()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.
add in interface Collection<E>
add in interface List<E>
add in class AbstractCollection<E>
add(size(), e).
Note that this implementation throws an UnsupportedOperationException unless add(int, E) is overridden.
e - element to be appended to this list
true (as specified by Collection.add(E))
UnsupportedOperationException - if the add operation is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
NullPointerException - if the specified element is null and this list does not permit null elements
IllegalArgumentException - if some property of this element prevents it from being added to this list
Returns the element at the specified position in this list.
get in interface List<E>
index - index of the element to return
IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
Replaces the element at the specified position in this list with the specified element (optional operation).
set in interface List<E>
UnsupportedOperationException.
index - index of the element to replace
element - element to be stored at the specified position
UnsupportedOperationException - if the set operation is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
NullPointerException - if the specified element is null and this list does not permit null elements
IllegalArgumentException - if some property of the specified element prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
add in interface List<E>
UnsupportedOperationException.
index - index at which the specified element is to be inserted
element - element to be inserted
UnsupportedOperationException - if the add operation is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
NullPointerException - if the specified element is null and this list does not permit null elements
IllegalArgumentException - if some property of the specified element prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
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.
remove in interface List<E>
UnsupportedOperationException.
index - the index of the element to be removed
UnsupportedOperationException - if the remove operation is not supported by this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
indexOf in interface List<E>
listIterator()). Then, it iterates over the list until the specified element is found or the end of the list is reached.
o - element to search for
ClassCastException - if the type of the specified element is incompatible with this list (optional)
NullPointerException - if the specified element is null and this list does not permit null elements (optional)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
lastIndexOf in interface List<E>
listIterator(size())). Then, it iterates backwards over the list until the specified element is found, or the beginning of the list is reached.
o - element to search for
ClassCastException - if the type of the specified element is incompatible with this list (optional)
NullPointerException - if the specified element is null and this list does not permit null elements (optional)
public void clear()
Removes all of the elements from this list (optional operation). The list will be empty after this call returns.
clear in interface Collection<E>
clear in interface List<E>
clear in class AbstractCollection<E>
removeRange(0, size()).
Note that this implementation throws an UnsupportedOperationException unless remove(int index) or removeRange(int fromIndex, int toIndex) is overridden.
UnsupportedOperationException - if the clear operation is not supported by this list
Inserts all of the elements in the specified collection into this list at the specified position (optional operation). 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 undefined 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.)
addAll in interface List<E>
add(int, E). Many implementations will override this method for efficiency.
Note that this implementation throws an UnsupportedOperationException unless add(int, E) is overridden.
index - index at which to insert the first element from the specified collection
c - collection containing elements to be added to this list
true if this list changed as a result of the call
UnsupportedOperationException - if the addAll operation is not supported by this list
ClassCastException - if the class of an element of the specified collection prevents it from being added to this list
NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null
IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
Returns an iterator over the elements in this list in proper sequence.
iterator in interface Collection<E>
iterator in interface Iterable<E>
iterator in interface List<E>
iterator in class AbstractCollection<E>
size(), get(int), and remove(int) methods.
Note that the iterator returned by this method will throw an UnsupportedOperationException in response to its remove method unless the list's remove(int) method is overridden.
This implementation can be made to throw runtime exceptions in the face of concurrent modification, as described in the specification for the (protected) modCount field.
Returns a list iterator over the elements in this list (in proper sequence).
listIterator in interface List<E>
listIterator(0).
Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to
next
. An initial call to
previous
would return the element with the specified index minus one.
listIterator in interface List<E>
ListIterator interface that extends the implementation of the Iterator interface returned by the iterator() method. The ListIterator implementation relies on the backing list's get(int), set(int, E), add(int, E) and remove(int) methods.
Note that the list iterator returned by this implementation will throw an UnsupportedOperationException in response to its remove, set and add methods unless the list's remove(int), set(int, E), and add(int, E) methods are overridden.
This implementation can be made to throw runtime exceptions in the face of concurrent modification, as described in the specification for the (protected) modCount field.
index - index of the first element to be returned from the list iterator (by a call to next)
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
Returns a view of the portion of this list between the specified
fromIndex
, inclusive, and
toIndex
, exclusive. (If
fromIndex
and
toIndex
are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.
This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:
list.subList(from, to).clear();
Similar idioms may be constructed for
indexOf
and
lastIndexOf
, and all of the algorithms in the
Collections
class can be applied to a subList.
The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)
subList in interface List<E>
AbstractList. The subclass stores, in private fields, the size of the subList (which can change over its lifetime), and the expected modCount value of the backing list. There are two variants of the subclass, one of which implements RandomAccess. If this list implements RandomAccess the returned list will be an instance of the subclass that implements RandomAccess.
The subclass's set(int, E), get(int), add(int, E), remove(int), addAll(int, Collection) and removeRange(int, int) methods all delegate to the corresponding methods on the backing abstract list, after bounds-checking the index and adjusting for the offset. The addAll(Collection c) method merely returns addAll(size, c).
The listIterator(int) method returns a "wrapper object" over a list iterator on the backing list, which is created with the corresponding method on the backing list. The iterator method merely returns listIterator(), and the size method merely returns the subclass's size field.
All methods first check to see if the actual modCount of the backing list is equal to its expected value, and throw a ConcurrentModificationException if it is not.
fromIndex - low endpoint (inclusive) of the subList
toIndex - high endpoint (exclusive) of the subList
IndexOutOfBoundsException - if an endpoint index value is out of range (fromIndex < 0 || toIndex > size)
IllegalArgumentException - if the endpoint indices are out of order (fromIndex > toIndex)
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.
equals in interface Collection<E>
equals in interface List<E>
equals in class Object
true; if not, it checks if the specified object is a list. If not, it returns false; if so, it iterates over both lists, comparing corresponding pairs of elements. If any comparison returns false, this method returns false. If either iterator runs out of elements before the other it returns false (as the lists are of unequal length); otherwise it returns true when the iterations complete.
o - the object to be compared for equality with this list
true if the specified object is equal to this list
public int hashCode()
Returns the hash code value for this list.
hashCode in interface Collection<E>
hashCode in interface List<E>
hashCode in class Object
List.hashCode() method.
protected void removeRange(int fromIndex, int toIndex)
Removes from this list all of the elements whose index is between
fromIndex
, inclusive, and
toIndex
, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by
(toIndex - fromIndex)
elements. (If
toIndex==fromIndex
, this operation has no effect.)
This method is called by the clear operation on this list and its subLists. Overriding this method to take advantage of the internals of the list implementation can substantially improve the performance of the clear operation on this list and its subLists.
fromIndex, and repeatedly calls ListIterator.next followed by ListIterator.remove until the entire range has been removed. Note: if ListIterator.remove requires linear time, this implementation requires quadratic time.
fromIndex - index of first element to be removed
toIndex - index after last element to be removed
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4