Appends the specified element to the end of this list (optional operation).
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.
e | element to be appended to this list |
true (as specified by Collection.add)
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 (optional operation). 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.)
c | collection containing elements to be added to this list |
true if this list changed as a result of the call
add(Object)
Removes all of the elements from this list (optional operation). 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
Objects.equals(o, e).
o | element whose presence in this list is to be tested |
true if this list contains the specified element
Returns true if this list contains all of the elements of the
specified collection.
c | collection to be checked for containment in this list |
true if this list contains all of the elements of the
specified collection
contains(Object)
Returns true if this list contains no elements.
true if this list contains no elements
Returns an iterator over the elements in this list in proper sequence.
Removes the first occurrence of the specified element from this list,
if it is present (optional operation). If this list does not contain
the element, it is unchanged. More formally, removes the element with
the lowest index i such that
Objects.equals(o, 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 |
true if this list contained the specified element
Removes from this list all of its elements that are contained in the specified collection (optional operation).
c | collection containing elements to be removed from this list |
true if this list changed as a result of the call
remove(Object), contains(Object)
Retains only the elements in this list that are contained in the specified collection (optional operation). 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
remove(Object), contains(Object)
Returns the number of elements in this list. If this list contains
more than Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
Creates a Spliterator over the elements in this list.
The Spliterator reports Spliterator.SIZED and
Spliterator.ORDERED. Implementations should document the
reporting of additional characteristic values.
Spliterator over the elements in this list
@implSpec The default implementation creates a late-binding spliterator as follows:
RandomAccess then the default
implementation creates a spliterator that traverses elements by
invoking the method List.get. If such invocation results or
would result in an IndexOutOfBoundsException then the
spliterator will fail-fast and throw a
ConcurrentModificationException.
If the list is also an instance of AbstractList then the
spliterator will use the list's modCount
field to provide additional fail-fast behavior.
Iterator. The spliterator inherits the
fail-fast of the list's iterator.
Spliterator additionally reports
Spliterator.SUBSIZED.
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 even if this list is backed by an array). The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based APIs.
Arrays.asList(Object[])
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 list 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.)
Like the toArray() method, this method acts as bridge between
array-based and collection-based APIs. Further, this method allows
precise control over the runtime type of the output array, and may,
under certain circumstances, be used to save allocation costs.
Suppose x is a list known to contain only strings.
The following code can be used to dump the list into a newly
allocated array of String:
String[] y = x.toArray(new String[0]);
toArray(new Object[0]) is identical in function to
toArray().
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. |
Diagram: Collection List