Java Doc for IteratorChain.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.IteratorChain

IteratorChain
public class IteratorChain implements Iterator(Code)
An IteratorChain is an Iterator that wraps a number of Iterators.

This class makes multiple iterators look like one to the caller When any method from the Iterator interface is called, the IteratorChain will delegate to a single underlying Iterator. The IteratorChain will invoke the Iterators in sequence until all Iterators are exhausted.

Under many circumstances, linking Iterators together in this manner is more efficient (and convenient) than reading out the contents of each Iterator into a List and creating a new Iterator.

Calling a method that adds new Iteratorafter a method in the Iterator interface has been called will result in an UnsupportedOperationException. Subclasses should take care to not alter the underlying List of Iterators.

NOTE: As from version 3.0, the IteratorChain may contain no iterators. In this case the class will function as an empty iterator.
since:
   Commons Collections 2.1
version:
   $Revision: 171347 $ $Date: 2005-05-22 18:27:34 +0100 (Sun, 22 May 2005) $
author:
   Morgan Delagrange
author:
   Stephen Colebourne



Field Summary
protected  IteratorcurrentIterator
    
protected  intcurrentIteratorIndex
    
protected  booleanisLocked
    
final protected  ListiteratorChain
    
protected  IteratorlastUsedIterator
    

Constructor Summary
public  IteratorChain()
     Construct an IteratorChain with no Iterators.
public  IteratorChain(Iterator iterator)
     Construct an IteratorChain with a single Iterator.
public  IteratorChain(Iterator a, Iterator b)
     Constructs a new IteratorChain over the two given iterators.
public  IteratorChain(Iterator[] iterators)
     Constructs a new IteratorChain over the array of iterators.
public  IteratorChain(Collection iterators)
     Constructs a new IteratorChain over the collection of iterators.

Method Summary
public  voidaddIterator(Iterator iterator)
    
public  ListgetIterators()
    
public  booleanhasNext()
     Return true if any Iterator in the IteratorChain has a remaining element.
public  booleanisLocked()
     Determine if modifications can still be made to the IteratorChain.
public  Objectnext()
    
public  voidremove()
     Removes from the underlying collection the last element returned by the Iterator.
public  voidsetIterator(int index, Iterator iterator)
    
public  intsize()
     Number of Iterators in the current IteratorChain.
protected  voidupdateCurrentIterator()
    

Field Detail
currentIterator
protected Iterator currentIterator(Code)
The current iterator



currentIteratorIndex
protected int currentIteratorIndex(Code)
The index of the current iterator



isLocked
protected boolean isLocked(Code)
ComparatorChain is "locked" after the first time compare(Object,Object) is called



iteratorChain
final protected List iteratorChain(Code)
The chain of iterators



lastUsedIterator
protected Iterator lastUsedIterator(Code)
The "last used" Iterator is the Iterator upon which next() or hasNext() was most recently called used for the remove() operation only




Constructor Detail
IteratorChain
public IteratorChain()(Code)
Construct an IteratorChain with no Iterators.

You will normally use IteratorChain.addIterator(Iterator) to add some iterators after using this constructor.




IteratorChain
public IteratorChain(Iterator iterator)(Code)
Construct an IteratorChain with a single Iterator.
Parameters:
  iterator - first Iterator in the IteratorChain
throws:
  NullPointerException - if the iterator is null



IteratorChain
public IteratorChain(Iterator a, Iterator b)(Code)
Constructs a new IteratorChain over the two given iterators.
Parameters:
  a - the first child iterator
Parameters:
  b - the second child iterator
throws:
  NullPointerException - if either iterator is null



IteratorChain
public IteratorChain(Iterator[] iterators)(Code)
Constructs a new IteratorChain over the array of iterators.
Parameters:
  iterators - the array of iterators
throws:
  NullPointerException - if iterators array is or contains null



IteratorChain
public IteratorChain(Collection iterators)(Code)
Constructs a new IteratorChain over the collection of iterators.
Parameters:
  iterators - the collection of iterators
throws:
  NullPointerException - if iterators collection is or contains null
throws:
  ClassCastException - if iterators collection doesn't contain an iterator




Method Detail
addIterator
public void addIterator(Iterator iterator)(Code)
Add an Iterator to the end of the chain
Parameters:
  iterator - Iterator to add
throws:
  IllegalStateException - if I've already started iterating
throws:
  NullPointerException - if the iterator is null



getIterators
public List getIterators()(Code)
Get the list of Iterators (unmodifiable) the unmodifiable list of iterators added



hasNext
public boolean hasNext()(Code)
Return true if any Iterator in the IteratorChain has a remaining element. true if elements remain



isLocked
public boolean isLocked()(Code)
Determine if modifications can still be made to the IteratorChain. IteratorChains cannot be modified once they have executed a method from the Iterator interface. true if IteratorChain cannot be modified, false if it can



next
public Object next()(Code)
Returns the next Object of the current Iterator Object from the current Iterator
throws:
  java.util.NoSuchElementException - if all the Iterators are exhausted



remove
public void remove()(Code)
Removes from the underlying collection the last element returned by the Iterator. As with next() and hasNext(), this method calls remove() on the underlying Iterator. Therefore, this method may throw an UnsupportedOperationException if the underlying Iterator does not support this method.
throws:
  UnsupportedOperationException - if the remove operator is not supported by the underlying Iterator
throws:
  IllegalStateException - if the next method has not yet been called, or the remove method hasalready been called after the last call to the next method.



setIterator
public void setIterator(int index, Iterator iterator) throws IndexOutOfBoundsException(Code)
Set the Iterator at the given index
Parameters:
  index - index of the Iterator to replace
Parameters:
  iterator - Iterator to place at the given index
throws:
  IndexOutOfBoundsException - if index < 0 or index > size()
throws:
  IllegalStateException - if I've already started iterating
throws:
  NullPointerException - if the iterator is null



size
public int size()(Code)
Number of Iterators in the current IteratorChain. Iterator count



updateCurrentIterator
protected void updateCurrentIterator()(Code)
Updates the current iterator field to ensure that the current Iterator is not exhausted



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.