Java Doc for List.java in  » Apache-Harmony-Java-SE » java-package » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Apache Harmony Java SE » java package » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.List

List
public interface List extends Collection<E>(Code)
List is a collection which maintains an ordering for its elements. Every element in the list has an index.




Method Summary
public  voidadd(int location, E object)
     Inserts the specified object into this Vector at the specified location. The object is inserted before any previous element at the specified location.
public  booleanadd(E object)
     Adds the specified object at the end of this List.
public  booleanaddAll(int location, Collection<? extends E> collection)
     Inserts the objects in the specified Collection at the specified location in this List.
public  booleanaddAll(Collection<? extends E> collection)
     Adds the objects in the specified Collection to the end of this List.
public  voidclear()
     Removes all elements from this List, leaving it empty.
public  booleancontains(Object object)
     Searches this List for the specified object.
public  booleancontainsAll(Collection collection)
     Searches this List for all objects in the specified Collection.
public  booleanequals(Object object)
     Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
Parameters:
  object - Object the object to compare with this object.
public  Eget(int location)
     Answers the element at the specified location in this List.
public  inthashCode()
     Answers an integer hash code for the receiver.
public  intindexOf(Object object)
     Searches this List for the specified object and returns the index of the first occurrence.
public  booleanisEmpty()
     Answers if this List has no elements, a size of zero.
public  Iterator<E>iterator()
     Answers an Iterator on the elements of this List.
public  intlastIndexOf(Object object)
     Searches this List for the specified object and returns the index of the last occurrence.
public  ListIterator<E>listIterator()
     Answers a ListIterator on the elements of this List.
public  ListIterator<E>listIterator(int location)
     Answers a ListIterator on the elements of this List.
public  Eremove(int location)
     Removes the object at the specified location from this List.
public  booleanremove(Object object)
     Removes the first occurrence of the specified object from this List.
public  booleanremoveAll(Collection collection)
     Removes all occurrences in this List of each object in the specified Collection.
public  booleanretainAll(Collection collection)
     Removes all objects from this List that are not contained in the specified Collection.
public  Eset(int location, E object)
     Replaces the element at the specified location in this List with the specified object.
public  intsize()
     Answers the number of elements in this List.
public  List<E>subList(int start, int end)
     Answers a List of the specified portion of this List from the start index to one less than the end index.
public  Object[]toArray()
     Answers an array containing all elements contained in this List.
public  T[]toArray(T[] array)
     Answers an array containing all elements contained in this List.



Method Detail
add
public void add(int location, E object)(Code)
Inserts the specified object into this Vector at the specified location. The object is inserted before any previous element at the specified location. If the location is equal to the size of this List, the object is added at the end.
Parameters:
  location - the index at which to insert
Parameters:
  object - the object to add
exception:
  UnsupportedOperationException - when adding to this List is not supported
exception:
  ClassCastException - when the class of the object is inappropriate for thisList
exception:
  IllegalArgumentException - when the object cannot be added to this List
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()



add
public boolean add(E object)(Code)
Adds the specified object at the end of this List.
Parameters:
  object - the object to add true
exception:
  UnsupportedOperationException - when adding to this List is not supported
exception:
  ClassCastException - when the class of the object is inappropriate for thisList
exception:
  IllegalArgumentException - when the object cannot be added to this List



addAll
public boolean addAll(int location, Collection<? extends E> collection)(Code)
Inserts the objects in the specified Collection at the specified location in this List. The objects are added in the order they are returned from the Collection iterator.
Parameters:
  location - the index at which to insert
Parameters:
  collection - the Collection of objects true if this List is modified, false otherwise
exception:
  UnsupportedOperationException - when adding to this List is not supported
exception:
  ClassCastException - when the class of an object is inappropriate for this List
exception:
  IllegalArgumentException - when an object cannot be added to this List
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()



addAll
public boolean addAll(Collection<? extends E> collection)(Code)
Adds the objects in the specified Collection to the end of this List. The objects are added in the order they are returned from the Collection iterator.
Parameters:
  collection - the Collection of objects true if this List is modified, false otherwise
exception:
  UnsupportedOperationException - when adding to this List is not supported
exception:
  ClassCastException - when the class of an object is inappropriate for this List
exception:
  IllegalArgumentException - when an object cannot be added to this List



clear
public void clear()(Code)
Removes all elements from this List, leaving it empty.
exception:
  UnsupportedOperationException - when removing from this List is not supported
See Also:   List.isEmpty
See Also:   List.size



contains
public boolean contains(Object object)(Code)
Searches this List for the specified object.
Parameters:
  object - the object to search for true if object is an element of this List, false otherwise



containsAll
public boolean containsAll(Collection collection)(Code)
Searches this List for all objects in the specified Collection.
Parameters:
  collection - the Collection of objects true if all objects in the specified Collection are elements ofthis List, false otherwise



equals
public boolean equals(Object object)(Code)
Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
Parameters:
  object - Object the object to compare with this object. boolean true if the object is the same as thisobject false if it is different from this object.
See Also:   List.hashCode



get
public E get(int location)(Code)
Answers the element at the specified location in this List.
Parameters:
  location - the index of the element to return the element at the specified location
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()



hashCode
public int hashCode()(Code)
Answers an integer hash code for the receiver. Objects which are equal answer the same value for this method. the receiver's hash
See Also:   List.equals



indexOf
public int indexOf(Object object)(Code)
Searches this List for the specified object and returns the index of the first occurrence.
Parameters:
  object - the object to search for the index of the first occurrence of the object



isEmpty
public boolean isEmpty()(Code)
Answers if this List has no elements, a size of zero. true if this List has no elements, false otherwise
See Also:   List.size



iterator
public Iterator<E> iterator()(Code)
Answers an Iterator on the elements of this List. The elements are iterated in the same order that they occur in the List. an Iterator on the elements of this List
See Also:   Iterator



lastIndexOf
public int lastIndexOf(Object object)(Code)
Searches this List for the specified object and returns the index of the last occurrence.
Parameters:
  object - the object to search for the index of the last occurrence of the object



listIterator
public ListIterator<E> listIterator()(Code)
Answers a ListIterator on the elements of this List. The elements are iterated in the same order that they occur in the List. a ListIterator on the elements of this List
See Also:   ListIterator



listIterator
public ListIterator<E> listIterator(int location)(Code)
Answers a ListIterator on the elements of this List. The elements are iterated in the same order that they occur in the List. The iteration starts at the specified location.
Parameters:
  location - the index at which to start the iteration a ListIterator on the elements of this List
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()
See Also:   ListIterator



remove
public E remove(int location)(Code)
Removes the object at the specified location from this List.
Parameters:
  location - the index of the object to remove the removed object
exception:
  UnsupportedOperationException - when removing from this List is not supported
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()



remove
public boolean remove(Object object)(Code)
Removes the first occurrence of the specified object from this List.
Parameters:
  object - the object to remove true if this List is modified, false otherwise
exception:
  UnsupportedOperationException - when removing from this List is not supported



removeAll
public boolean removeAll(Collection collection)(Code)
Removes all occurrences in this List of each object in the specified Collection.
Parameters:
  collection - the Collection of objects to remove true if this List is modified, false otherwise
exception:
  UnsupportedOperationException - when removing from this List is not supported



retainAll
public boolean retainAll(Collection collection)(Code)
Removes all objects from this List that are not contained in the specified Collection.
Parameters:
  collection - the Collection of objects to retain true if this List is modified, false otherwise
exception:
  UnsupportedOperationException - when removing from this List is not supported



set
public E set(int location, E object)(Code)
Replaces the element at the specified location in this List with the specified object.
Parameters:
  location - the index at which to put the specified object
Parameters:
  object - the object to add the previous element at the index
exception:
  UnsupportedOperationException - when replacing elements in this List is not supported
exception:
  ClassCastException - when the class of an object is inappropriate for this List
exception:
  IllegalArgumentException - when an object cannot be added to this List
exception:
  IndexOutOfBoundsException - when location < 0 || >= size()



size
public int size()(Code)
Answers the number of elements in this List. the number of elements in this List



subList
public List<E> subList(int start, int end)(Code)
Answers a List of the specified portion of this List from the start index to one less than the end index. The returned List is backed by this list so changes to one are reflected by the other.
Parameters:
  start - the index at which to start the sublist
Parameters:
  end - the index one past the end of the sublist a List of a portion of this List
exception:
  IndexOutOfBoundsException - when start < 0, start > end orend > size()



toArray
public Object[] toArray()(Code)
Answers an array containing all elements contained in this List. an array of the elements from this List



toArray
public T[] toArray(T[] array)(Code)
Answers an array containing all elements contained in this List. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this List, the array element following the collection elements is set to null.
Parameters:
  array - the array an array of the elements from this List
exception:
  ArrayStoreException - when the type of an element in this List cannot be storedin the type of the specified array



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