Java Doc for ObjectArrayListIterator.java in  » Library » Apache-common-Collections » org » apache » commons » collections » iterators » 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 » Library » Apache common Collections » org.apache.commons.collections.iterators 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.collections.iterators.ObjectArrayIterator
      org.apache.commons.collections.iterators.ObjectArrayListIterator

ObjectArrayListIterator
public class ObjectArrayListIterator extends ObjectArrayIterator implements ListIterator,ResettableListIterator(Code)
Implements a ListIterator over an array of objects.

This iterator does not support ObjectArrayListIterator.add or ObjectArrayListIterator.remove , as the object array cannot be structurally modified. The ObjectArrayListIterator.set method is supported however.

The iterator implements a ObjectArrayListIterator.reset method, allowing the reset of the iterator back to the start if required.
See Also:   org.apache.commons.collections.iterators.ObjectArrayIterator
See Also:   java.util.Iterator
See Also:   java.util.ListIterator
since:
   Commons Collections 3.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Neil O'Toole
author:
   Stephen Colebourne
author:
   Phil Steitz



Field Summary
protected  intlastItemIndex
     Holds the index of the last item returned by a call to next() or previous().

Constructor Summary
public  ObjectArrayListIterator()
     Constructor for use with setArray.
public  ObjectArrayListIterator(Object[] array)
     Constructs an ObjectArrayListIterator that will iterate over the values in the specified array.
public  ObjectArrayListIterator(Object[] array, int start)
     Constructs an ObjectArrayListIterator that will iterate over the values in the specified array from a specific start index.
public  ObjectArrayListIterator(Object[] array, int start, int end)
     Construct an ObjectArrayListIterator that will iterate over a range of values in the specified array.

Method Summary
public  voidadd(Object obj)
     This iterator does not support modification of its backing array's size, and so will always throw an UnsupportedOperationException when this method is invoked.
public  booleanhasPrevious()
     Returns true if there are previous elements to return from the array.
public  Objectnext()
     Gets the next element from the array.
public  intnextIndex()
     Gets the next index to be retrieved.
public  Objectprevious()
     Gets the previous element from the array.
public  intpreviousIndex()
     Gets the index of the item to be retrieved if ObjectArrayListIterator.previous() is called.
public  voidreset()
     Resets the iterator back to the start index.
public  voidset(Object obj)
     Sets the element under the cursor.

This method sets the element that was returned by the last call to ObjectArrayListIterator.next() of ObjectArrayListIterator.previous() .


Field Detail
lastItemIndex
protected int lastItemIndex(Code)
Holds the index of the last item returned by a call to next() or previous(). This is set to -1 if neither method has yet been invoked. lastItemIndex is used to to implement the ObjectArrayListIterator.set method.




Constructor Detail
ObjectArrayListIterator
public ObjectArrayListIterator()(Code)
Constructor for use with setArray.

Using this constructor, the iterator is equivalent to an empty iterator until ObjectArrayListIterator.setArray is called to establish the array to iterate over.




ObjectArrayListIterator
public ObjectArrayListIterator(Object[] array)(Code)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array.
Parameters:
  array - the array to iterate over
throws:
  NullPointerException - if array is null



ObjectArrayListIterator
public ObjectArrayListIterator(Object[] array, int start)(Code)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array from a specific start index.
Parameters:
  array - the array to iterate over
Parameters:
  start - the index to start iterating at
throws:
  NullPointerException - if array is null
throws:
  IndexOutOfBoundsException - if the start index is out of bounds



ObjectArrayListIterator
public ObjectArrayListIterator(Object[] array, int start, int end)(Code)
Construct an ObjectArrayListIterator that will iterate over a range of values in the specified array.
Parameters:
  array - the array to iterate over
Parameters:
  start - the index to start iterating at
Parameters:
  end - the index (exclusive) to finish iterating at
throws:
  IndexOutOfBoundsException - if the start or end index is out of bounds
throws:
  IllegalArgumentException - if end index is before the start
throws:
  NullPointerException - if array is null




Method Detail
add
public void add(Object obj)(Code)
This iterator does not support modification of its backing array's size, and so will always throw an UnsupportedOperationException when this method is invoked.
Parameters:
  obj - the object to add
throws:
  UnsupportedOperationException - always thrown.



hasPrevious
public boolean hasPrevious()(Code)
Returns true if there are previous elements to return from the array. true if there is a previous element to return



next
public Object next()(Code)
Gets the next element from the array. the next element
throws:
  NoSuchElementException - if there is no next element



nextIndex
public int nextIndex()(Code)
Gets the next index to be retrieved. the index of the item to be retrieved next



previous
public Object previous()(Code)
Gets the previous element from the array. the previous element
throws:
  NoSuchElementException - if there is no previous element



previousIndex
public int previousIndex()(Code)
Gets the index of the item to be retrieved if ObjectArrayListIterator.previous() is called. the index of the item to be retrieved next



reset
public void reset()(Code)
Resets the iterator back to the start index.



set
public void set(Object obj)(Code)
Sets the element under the cursor.

This method sets the element that was returned by the last call to ObjectArrayListIterator.next() of ObjectArrayListIterator.previous() . Note: ListIterator implementations that support add() and remove() only allow set() to be called once per call to next() or previous (see the ListIterator javadoc for more details). Since this implementation does not support add() or remove(), set() may be called as often as desired.
Parameters:
  obj - the object to set into the array
throws:
  IllegalStateException - if next() has not yet been called.
throws:
  ClassCastException - if the object type is unsuitable for the array




Fields inherited from org.apache.commons.collections.iterators.ObjectArrayIterator
protected Object[] array(Code)(Java Doc)
protected int endIndex(Code)(Java Doc)
protected int index(Code)(Java Doc)
protected int startIndex(Code)(Java Doc)

Methods inherited from org.apache.commons.collections.iterators.ObjectArrayIterator
public Object[] getArray()(Code)(Java Doc)
public int getEndIndex()(Code)(Java Doc)
public int getStartIndex()(Code)(Java Doc)
public boolean hasNext()(Code)(Java Doc)
public Object next()(Code)(Java Doc)
public void remove()(Code)(Java Doc)
public void reset()(Code)(Java Doc)
public void setArray(Object[] array)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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