void |
add(int index, Object element) Inserts the specified element at the specified position in this list (optional operation). |
boolean |
add(Object o) Appends the specified element to the end of this list (optional operation). |
boolean |
addAll(Collection c) 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). |
boolean |
addAll(int index, Collection c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation). |
void |
clear() Removes all of the elements from this list (optional operation). |
boolean |
contains(Object o) Returns true if this list contains the specified element. |
boolean |
containsAll(Collection c) Returns true if this list contains all of the elements of the specified collection. |
boolean |
equals(Object o) Compares the specified object with this list for equality. |
Object |
get(int index) Returns the element at the specified position in this list. |
int |
hashCode() Returns the hash code value for this list. |
int |
indexOf(Object o) Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. |
boolean |
isEmpty() Returns true if this list contains no elements. |
Iterator |
iterator() Returns an iterator over the elements in this list in proper sequence. |
int |
lastIndexOf(Object o) 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 |
listIterator() Returns a list iterator of the elements in this list (in proper sequence). |
ListIterator |
listIterator(int index) Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. |
Object |
remove(int index) Removes the element at the specified position in this list (optional operation). |
boolean |
remove(Object o) Removes the first occurrence in this list of the specified element (optional operation). |
boolean |
removeAll(Collection c) Removes from this list all the elements that are contained in the specified collection (optional operation). |
boolean |
retainAll(Collection c) Retains only the elements in this list that are contained in the specified collection (optional operation). |
Object |
set(int index, Object element) Replaces the element at the specified position in this list with the specified element (optional operation). |
int |
size() Returns the number of elements in this list. |
List |
subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. |
Object[] |
toArray() Returns an array containing all of the elements in this list in proper sequence. |
Object[] |
toArray(Object[] a) 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. |
Method Detail |
public int size()
size
in interface CollectionManual
- Arrays
- array_ change_ key_ case
- array_ chunk
- array_ combine
- array_ count_ values
- array_ diff_ assoc
- array_ diff_ key
- array_ diff_ uassoc
- array_ diff_ ukey
- array_ diff
- array_ fill
- array_ filter
- array_ flip
- array_ intersect_ assoc
- array_ intersect_ key
- array_ intersect_ uassoc
- array_ intersect_ ukey
- array_ intersect
- array_ key_ exists
- array_ keys
- array_ map
- array_ merge_ recursive
- array_ merge
- array_ multisort
- array_ pad
- array_ pop
- array_ product
- array_ push
- array_ rand
- array_ reduce
- array_ reverse
- array_ search
- array_ shift
- array_ slice
- array_ splice
- array_ sum
- array_ udiff_ assoc
- array_ udiff_ uassoc
- array_ udiff
- array_ uintersect_ assoc
- array_ uintersect_ uassoc
- array_ uintersect
- array_ unique
- array_ unshift
- array_ values
- array_ walk_ recursive
- array_ walk
- array
- arsort
- asort
- compact
- count
- current
- each
- end
- extract
- in_ array
- key
- krsort
- ksort
- list
- natcasesort
- natsort
- next
- pos
- prev
- range
- reset
- rsort
- shuffle
- sizeof
- sort
- uasort
- uksort
- usort
public boolean isEmpty()
isEmpty
in interface Collection
public boolean contains(Object o)
contains
in interface Collection
o
- element whose presence in this list is to be tested.
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 support null elements (optional).public Iterator iterator()
iterator
in interface Collection
public Object[] toArray()
toArray
in interface Collection
Arrays.asList(Object[])
public Object[] toArray(Object[] a)
toArray
in interface Collection
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.
ArrayStoreException
- if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.
NullPointerException
- if the specified array is null.public boolean add(Object o)
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
o
- element to be appended to this list.
UnsupportedOperationException
- if the add method 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 support null elements.
IllegalArgumentException
- if some aspect of this element prevents it from being added to this list.public boolean remove(Object o)
remove
in interface Collection
o
- element to be removed from this list, if present.
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 support null elements (optional).
UnsupportedOperationException
- if the remove method is not supported by this list.public boolean containsAll(Collection c)
containsAll
in interface Collection
c
- collection to be checked for containment in this list.
ClassCastException
- if the types of one or more elements in the specified collection are incompatible with this list (optional).
NullPointerException
- if the specified collection contains one or more null elements and this list does not support null elements (optional).
NullPointerException
- if the specified collection is null.
contains(Object)
public boolean addAll(Collection c)
addAll
in interface Collection
c
- collection whose elements are to be added to this list.
UnsupportedOperationException
- if the addAll method is not supported by this list.
ClassCastException
- if the class of an element in 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 support null elements, or if the specified collection is null.
IllegalArgumentException
- if some aspect of an element in the specified collection prevents it from being added to this list.
add(Object)
public boolean addAll(int index, Collection c)
index
- index at which to insert first element from the specified collection.
c
- elements to be inserted into this list.
UnsupportedOperationException
- if the addAll method is not supported by this list.
ClassCastException
- if the class of one of elements 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 support null elements, or if the specified collection is null.
IllegalArgumentException
- if some aspect of one of elements of the specified collection prevents it from being added to this list.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index > size()).public boolean removeAll(Collection c)
removeAll
in interface Collection
c
- collection that defines which elements will be removed from this list.
UnsupportedOperationException
- if the removeAll method is not supported by this list.
ClassCastException
- if the types of one or more elements in this list are incompatible with the specified collection (optional).
NullPointerException
- if this list contains one or more null elements and the specified collection does not support null elements (optional).
NullPointerException
- if the specified collection is null.
remove(Object)
, contains(Object)
public boolean retainAll(Collection c)
retainAll
in interface Collection
c
- collection that defines which elements this set will retain.
UnsupportedOperationException
- if the retainAll method is not supported by this list.
ClassCastException
- if the types of one or more elements in this list are incompatible with the specified collection (optional).
NullPointerException
- if this list contains one or more null elements and the specified collection does not support null elements (optional).
NullPointerException
- if the specified collection is null.
remove(Object)
, contains(Object)
public void clear()
clear
in interface Collection
UnsupportedOperationException
- if the clear method is not supported by this list.public boolean equals(Object o)
equals
in interface Collection
equals
in class Object
o
- the object to be compared for equality with this list.
Object.hashCode()
, Hashtable
public int hashCode()
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.
hashCode
in interface Collection
hashCode
in class Object
Object.hashCode()
, Object.equals(Object)
, equals(Object)
public Object get(int index)
index
- index of element to return.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= size()).public Object set(int index, Object element)
index
- index of element to replace.
element
- element to be stored at the specified position.
UnsupportedOperationException
- if the set method 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 support null elements.
IllegalArgumentException
- if some aspect of the specified element prevents it from being added to this list.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= size()).public void add(int index, Object element)
index
- index at which the specified element is to be inserted.
element
- element to be inserted.
UnsupportedOperationException
- if the add method 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 support null elements.
IllegalArgumentException
- if some aspect of the specified element prevents it from being added to this list.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index > size()).public Object remove(int index)
index
- the index of the element to removed.
UnsupportedOperationException
- if the remove method is not supported by this list.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= size()).public int indexOf(Object o)
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 support null elements (optional).public int lastIndexOf(Object o)
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 support null elements (optional).public ListIterator listIterator()
public ListIterator listIterator(int index)
index
- index of first element to be returned from the list iterator (by a call to the next method).
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index > size()).public List subList(int fromIndex, int toIndex)
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.)
fromIndex
- low endpoint (inclusive) of the subList.
toIndex
- high endpoint (exclusive) of the subList.
IndexOutOfBoundsException
- for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).