Appends the specified element to the end of this list.
e | element to be appended to this list |
Collection.add
)
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).
index | index at which the specified element is to be inserted | |
element | element to be inserted |
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 undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this list, and this list is nonempty.)
c | collection containing elements to be added to this list |
Inserts all of the elements in the specified collection into this list, starting 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 the list in the order that they are returned by the specified collection's iterator.
index | index at which to insert the first element from the specified collection | |
c | collection containing elements to be added to this list |
Removes all of the elements from this list. The list will be empty after this call returns.
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)).
o | element whose presence in this list is to be tested |
Performs the given action for each element of the Iterable
until all elements have been processed or the action throws an
exception. Unless otherwise specified by the implementing class,
actions are performed in the order of iteration (if an iteration order
is specified). Exceptions thrown by the action are relayed to the
caller.
action | The action to be performed for each element |
Returns the element at the specified position in this list.
index | index of the element to return |
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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
o | element to search for |
Returns true if this list contains no elements.
Returns an iterator over the elements in this list in proper sequence.
The returned iterator is fail-fast.
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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
o | element to search for |
Returns a list iterator over the elements in this list (in proper sequence).
The returned list iterator is fail-fast.
listIterator(int)
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.
The returned list iterator is fail-fast.
index | index of the first element to be returned from the
list iterator (by a call to next ) |
Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
index | the index of the element to be removed |
Removes the first occurrence of the specified element from this list, if it is present. If the 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). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
o | element to be removed from this list, if present |
Removes from this list all of its elements that are contained in the specified collection.
c | collection containing elements to be removed from this list |
true
if this list changed as a result of the call
Collection.contains(Object)
Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.
filter | a predicate which returns true for elements to be
removed |
true
if any elements were removed
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.)
fromIndex | index of first element to be removed | |
toIndex | index after last element to be removed |
Replaces each element of this list with the result of applying the operator to that element. Errors or runtime exceptions thrown by the operator are relayed to the caller.
operator | the operator to apply to each element |
Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all of its elements that are not contained in the specified collection.
c | collection containing elements to be retained in this list |
true
if this list changed as a result of the call
Collection.contains(Object)
Replaces the element at the specified position in this list with the specified element.
index | index of the element to replace | |
element | element to be stored at the specified position |
Returns the number of elements in this list.
Sorts this list according to the order induced by the specified
Comparator
.
All elements in this list must be mutually comparable using the
specified comparator (that is, c.compare(e1, e2)
must not throw
a ClassCastException
for any elements e1
and e2
in the list).
If the specified comparator is null
then all elements in this
list must implement the Comparable
interface and the elements'
natural ordering should be used.
This list must be modifiable, but need not be resizable.
c | the Comparator used to compare list elements.
A null value indicates that the elements'
natural ordering should be used |
Creates a late-binding
and fail-fast Spliterator
over the elements in this
list.
The Spliterator
reports Spliterator.SIZED
,
Spliterator.SUBSIZED
, and Spliterator.ORDERED
.
Overriding implementations should document the reporting of additional
characteristic values.
Spliterator
over the elements in this list
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.
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(Object)
and
lastIndexOf(Object)
, 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.)
fromIndex | low endpoint (inclusive) of the subList | |
toIndex | high endpoint (exclusive) of the subList |
Returns an array containing all of the elements in this list in proper sequence (from first to last element).
The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based APIs.
Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.
If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)
a | the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. |
Diagram: Collection List