Java Doc for List.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Collections Jar Zip Logging regex » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.List

List
public interface List extends Collection<E>(Code)
An ordered collection (also known as a sequence). The user of this interface has precise control over where in the list each element is inserted. The user can access elements by their integer index (position in the list), and search for elements in the list.

Unlike sets, lists typically allow duplicate elements. More formally, lists typically allow pairs of elements e1 and e2 such that e1.equals(e2), and they typically allow multiple null elements if they allow null elements at all. It is not inconceivable that someone might wish to implement a list that prohibits duplicates, by throwing runtime exceptions when the user attempts to insert them, but we expect this usage to be rare.

The List interface places additional stipulations, beyond those specified in the Collection interface, on the contracts of the iterator, add, remove, equals, and hashCode methods. Declarations for other inherited methods are also included here for convenience.

The List interface provides four methods for positional (indexed) access to list elements. Lists (like Java arrays) are zero based. Note that these operations may execute in time proportional to the index value for some implementations (the LinkedList class, for example). Thus, iterating over the elements in a list is typically preferable to indexing through it if the caller does not know the implementation.

The List interface provides a special iterator, called a ListIterator, that allows element insertion and replacement, and bidirectional access in addition to the normal operations that the Iterator interface provides. A method is provided to obtain a list iterator that starts at a specified position in the list.

The List interface provides two methods to search for a specified object. From a performance standpoint, these methods should be used with caution. In many implementations they will perform costly linear searches.

The List interface provides two methods to efficiently insert and remove multiple elements at an arbitrary point in the list.

Note: While it is permissible for lists to contain themselves as elements, extreme caution is advised: the equals and hashCode methods are no longer well defined on such a list.

Some list implementations have restrictions on the elements that they may contain. For example, some implementations prohibit null elements, and some have restrictions on the types of their elements. Attempting to add an ineligible element throws an unchecked exception, typically NullPointerException or ClassCastException. Attempting to query the presence of an ineligible element may throw an exception, or it may simply return false; some implementations will exhibit the former behavior and some will exhibit the latter. More generally, attempting an operation on an ineligible element whose completion would not result in the insertion of an ineligible element into the list may throw an exception or it may succeed, at the option of the implementation. Such exceptions are marked as "optional" in the specification for this interface.

This interface is a member of the Java Collections Framework.
author:
   Josh Bloch
author:
   Neal Gafter
version:
   1.58, 06/24/07
See Also:   Collection
See Also:   Set
See Also:   ArrayList
See Also:   LinkedList
See Also:   Vector
See Also:   Arrays.asList(Object[])
See Also:   Collections.nCopies(intObject)
See Also:   Collections.EMPTY_LIST
See Also:   AbstractList
See Also:   AbstractSequentialList
since:
   1.2





Method Summary
 booleanadd(E e)
     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.

 voidadd(int index, E element)
     Inserts the specified element at the specified position in this list (optional operation).
 booleanaddAll(Collection<? extends E> 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).
 booleanaddAll(int index, Collection<? extends E> c)
     Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
 voidclear()
     Removes all of the elements from this list (optional operation).
 booleancontains(Object o)
     Returns true if this list contains the specified element.
 booleancontainsAll(Collection c)
     Returns true if this list contains all of the elements of the specified collection.
 booleanequals(Object o)
     Compares the specified object with this list for equality.
 Eget(int index)
     Returns the element at the specified position in this list.
 inthashCode()
     Returns the hash code value for this list.
 intindexOf(Object o)
     Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
 booleanisEmpty()
     Returns true if this list contains no elements.
 Iterator<E>iterator()
     Returns an iterator over the elements in this list in proper sequence.
 intlastIndexOf(Object o)
     Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
 ListIterator<E>listIterator()
     Returns a list iterator over the elements in this list (in proper sequence).
 ListIterator<E>listIterator(int index)
     Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
 booleanremove(Object o)
     Removes the first occurrence of the specified element from this list, if it is present (optional operation).
 Eremove(int index)
     Removes the element at the specified position in this list (optional operation).
 booleanremoveAll(Collection c)
     Removes from this list all of its elements that are contained in the specified collection (optional operation).
 booleanretainAll(Collection c)
     Retains only the elements in this list that are contained in the specified collection (optional operation).
 Eset(int index, E element)
     Replaces the element at the specified position in this list with the specified element (optional operation).
 intsize()
     Returns the number of elements in this list.
 List<E>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 (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list.

 T[]toArray(T[] a)
     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.



Method Detail
add
boolean add(E e)(Code)
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.
Parameters:
  e - element to be appended to this list true (as specified by Collection.add)
throws:
  UnsupportedOperationException - if the add operationis not supported by this list
throws:
  ClassCastException - if the class of the specified elementprevents it from being added to this list
throws:
  NullPointerException - if the specified element is null and thislist does not permit null elements
throws:
  IllegalArgumentException - if some property of this elementprevents it from being added to this list




add
void add(int index, E element)(Code)
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).
Parameters:
  index - index at which the specified element is to be inserted
Parameters:
  element - element to be inserted
throws:
  UnsupportedOperationException - if the add operationis not supported by this list
throws:
  ClassCastException - if the class of the specified elementprevents it from being added to this list
throws:
  NullPointerException - if the specified element is null andthis list does not permit null elements
throws:
  IllegalArgumentException - if some property of the specifiedelement prevents it from being added to this list
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index > size())



addAll
boolean addAll(Collection<? extends E> c)(Code)
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.)
Parameters:
  c - collection containing elements to be added to this list true if this list changed as a result of the call
throws:
  UnsupportedOperationException - if the addAll operationis not supported by this list
throws:
  ClassCastException - if the class of an element of the specifiedcollection prevents it from being added to this list
throws:
  NullPointerException - if the specified collection contains oneor more null elements and this list does not permit nullelements, or if the specified collection is null
throws:
  IllegalArgumentException - if some property of an element of thespecified collection prevents it from being added to this list
See Also:   List.add(Object)



addAll
boolean addAll(int index, Collection<? extends E> c)(Code)
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.)
Parameters:
  index - index at which to insert the first element from thespecified collection
Parameters:
  c - collection containing elements to be added to this list true if this list changed as a result of the call
throws:
  UnsupportedOperationException - if the addAll operationis not supported by this list
throws:
  ClassCastException - if the class of an element of the specifiedcollection prevents it from being added to this list
throws:
  NullPointerException - if the specified collection contains oneor more null elements and this list does not permit nullelements, or if the specified collection is null
throws:
  IllegalArgumentException - if some property of an element of thespecified collection prevents it from being added to this list
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index > size())



clear
void clear()(Code)
Removes all of the elements from this list (optional operation). The list will be empty after this call returns.
throws:
  UnsupportedOperationException - if the clear operationis not supported by this list



contains
boolean contains(Object o)(Code)
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)).
Parameters:
  o - element whose presence in this list is to be tested true if this list contains the specified element
throws:
  ClassCastException - if the type of the specified elementis incompatible with this list (optional)
throws:
  NullPointerException - if the specified element is null and thislist does not permit null elements (optional)



containsAll
boolean containsAll(Collection c)(Code)
Returns true if this list contains all of the elements of the specified collection.
Parameters:
  c - collection to be checked for containment in this list true if this list contains all of the elements of thespecified collection
throws:
  ClassCastException - if the types of one or more elementsin the specified collection are incompatible with thislist (optional)
throws:
  NullPointerException - if the specified collection contains oneor more null elements and this list does not permit nullelements (optional), or if the specified collection is null
See Also:   List.contains(Object)



equals
boolean equals(Object o)(Code)
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.
Parameters:
  o - the object to be compared for equality with this list true if the specified object is equal to this list



get
E get(int index)(Code)
Returns the element at the specified position in this list.
Parameters:
  index - index of the element to return the element at the specified position in this list
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index >= size())



hashCode
int hashCode()(Code)
Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:
 int hashCode = 1;
 for (E e : list)
 hashCode = 31*hashCode + (e==null ? 0 : e.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 . the hash code value for this list
See Also:   Object.equals(Object)
See Also:   List.equals(Object)



indexOf
int indexOf(Object o)(Code)
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.
Parameters:
  o - element to search for the index of the first occurrence of the specified element inthis list, or -1 if this list does not contain the element
throws:
  ClassCastException - if the type of the specified elementis incompatible with this list (optional)
throws:
  NullPointerException - if the specified element is null and thislist does not permit null elements (optional)



isEmpty
boolean isEmpty()(Code)
Returns true if this list contains no elements. true if this list contains no elements



iterator
Iterator<E> iterator()(Code)
Returns an iterator over the elements in this list in proper sequence. an iterator over the elements in this list in proper sequence



lastIndexOf
int lastIndexOf(Object o)(Code)
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.
Parameters:
  o - element to search for the index of the last occurrence of the specified element inthis list, or -1 if this list does not contain the element
throws:
  ClassCastException - if the type of the specified elementis incompatible with this list (optional)
throws:
  NullPointerException - if the specified element is null and thislist does not permit null elements (optional)



listIterator
ListIterator<E> listIterator()(Code)
Returns a list iterator over the elements in this list (in proper sequence). a list iterator over the elements in this list (in propersequence)



listIterator
ListIterator<E> listIterator(int index)(Code)
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 ListIterator.next next . An initial call to ListIterator.previous previous would return the element with the specified index minus one.
Parameters:
  index - index of the first element to be returned from thelist iterator (by a call to ListIterator.next next) a list iterator over the elements in this list (in propersequence), starting at the specified position in the list
throws:
  IndexOutOfBoundsException - if the index is out of range( index < 0 || index > size() )



remove
boolean remove(Object o)(Code)
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 (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).
Parameters:
  o - element to be removed from this list, if present true if this list contained the specified element
throws:
  ClassCastException - if the type of the specified elementis incompatible with this list (optional)
throws:
  NullPointerException - if the specified element is null and thislist does not permit null elements (optional)
throws:
  UnsupportedOperationException - if the remove operationis not supported by this list



remove
E remove(int index)(Code)
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.
Parameters:
  index - the index of the element to be removed the element previously at the specified position
throws:
  UnsupportedOperationException - if the remove operationis not supported by this list
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index >= size())



removeAll
boolean removeAll(Collection c)(Code)
Removes from this list all of its elements that are contained in the specified collection (optional operation).
Parameters:
  c - collection containing elements to be removed from this list true if this list changed as a result of the call
throws:
  UnsupportedOperationException - if the removeAll operationis not supported by this list
throws:
  ClassCastException - if the class of an element of this listis incompatible with the specified collection (optional)
throws:
  NullPointerException - if this list contains a null element and thespecified collection does not permit null elements (optional),or if the specified collection is null
See Also:   List.remove(Object)
See Also:   List.contains(Object)



retainAll
boolean retainAll(Collection c)(Code)
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.
Parameters:
  c - collection containing elements to be retained in this list true if this list changed as a result of the call
throws:
  UnsupportedOperationException - if the retainAll operationis not supported by this list
throws:
  ClassCastException - if the class of an element of this listis incompatible with the specified collection (optional)
throws:
  NullPointerException - if this list contains a null element and thespecified collection does not permit null elements (optional),or if the specified collection is null
See Also:   List.remove(Object)
See Also:   List.contains(Object)



set
E set(int index, E element)(Code)
Replaces the element at the specified position in this list with the specified element (optional operation).
Parameters:
  index - index of the element to replace
Parameters:
  element - element to be stored at the specified position the element previously at the specified position
throws:
  UnsupportedOperationException - if the set operationis not supported by this list
throws:
  ClassCastException - if the class of the specified elementprevents it from being added to this list
throws:
  NullPointerException - if the specified element is null andthis list does not permit null elements
throws:
  IllegalArgumentException - if some property of the specifiedelement prevents it from being added to this list
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index >= size())



size
int size()(Code)
Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE. the number of elements in this list



subList
List<E> subList(int fromIndex, int toIndex)(Code)
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.)
Parameters:
  fromIndex - low endpoint (inclusive) of the subList
Parameters:
  toIndex - high endpoint (exclusive) of the subList a view of the specified range within this list
throws:
  IndexOutOfBoundsException - for an illegal endpoint index value(fromIndex < 0 || toIndex > size ||fromIndex > toIndex)




toArray
Object[] toArray()(Code)
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. an array containing all of the elements in this list in propersequence
See Also:   Arrays.asList(Object[])




toArray
T[] toArray(T[] a)(Code)
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 List.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]);
Note that toArray(new Object[0]) is identical in function to toArray().
Parameters:
  a - the array into which the elements of this list are tobe stored, if it is big enough; otherwise, a new array of thesame runtime type is allocated for this purpose. an array containing the elements of this list
throws:
  ArrayStoreException - if the runtime type of the specified arrayis not a supertype of the runtime type of every element inthis list
throws:
  NullPointerException - if the specified array is null



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.