|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections.iterators.CollatingIterator
public class CollatingIterator
Provides an ordered iteration over the elements contained in a collection of ordered Iterators.
Given two ordered Iterator
instances A
and B
,
the next()
method on this iterator will return the lesser of
A.next()
and B.next()
.
Constructor Summary | |
---|---|
CollatingIterator()
Constructs a new CollatingIterator . |
|
CollatingIterator(Comparator comp)
Constructs a new CollatingIterator that will used the
specified comparator for ordering. |
|
CollatingIterator(Comparator comp,
Collection iterators)
Constructs a new CollatingIterator that will use the
specified comparator to provide ordered iteration over the collection
of iterators. |
|
CollatingIterator(Comparator comp,
int initIterCapacity)
Constructs a new CollatingIterator that will used the
specified comparator for ordering and have the specified initial
capacity. |
|
CollatingIterator(Comparator comp,
Iterator[] iterators)
Constructs a new CollatingIterator that will use the
specified comparator to provide ordered iteration over the array
of iterators. |
|
CollatingIterator(Comparator comp,
Iterator a,
Iterator b)
Constructs a new CollatingIterator that will use the
specified comparator to provide ordered iteration over the two
given iterators. |
Method Summary | |
---|---|
void |
addIterator(Iterator iterator)
Adds the given Iterator to the iterators being collated. |
Comparator |
getComparator()
Gets the Comparator by which collatation occurs. |
List |
getIterators()
Gets the list of Iterators (unmodifiable). |
boolean |
hasNext()
Returns true if any child iterator has remaining elements. |
Object |
next()
Returns the next ordered element from a child iterator. |
void |
remove()
Removes the last returned element from the child iterator that produced it. |
void |
setComparator(Comparator comp)
Sets the Comparator by which collation occurs. |
void |
setIterator(int index,
Iterator iterator)
Sets the iterator at the given index. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CollatingIterator()
CollatingIterator
. Natural sort order
will be used, and child iterators will have to be manually added
using the addIterator(Iterator)
method.
public CollatingIterator(Comparator comp)
CollatingIterator
that will used the
specified comparator for ordering. Child iterators will have to be
manually added using the addIterator(Iterator)
method.
comp
- the comparator to use to sort, or null to use natural sort orderpublic CollatingIterator(Comparator comp, int initIterCapacity)
CollatingIterator
that will used the
specified comparator for ordering and have the specified initial
capacity. Child iterators will have to be
manually added using the addIterator(Iterator)
method.
comp
- the comparator to use to sort, or null to use natural sort orderinitIterCapacity
- the initial capacity for the internal list
of child iteratorspublic CollatingIterator(Comparator comp, Iterator a, Iterator b)
CollatingIterator
that will use the
specified comparator to provide ordered iteration over the two
given iterators.
comp
- the comparator to use to sort, or null to use natural sort ordera
- the first child ordered iteratorb
- the second child ordered iterator
NullPointerException
- if either iterator is nullpublic CollatingIterator(Comparator comp, Iterator[] iterators)
CollatingIterator
that will use the
specified comparator to provide ordered iteration over the array
of iterators.
comp
- the comparator to use to sort, or null to use natural sort orderiterators
- the array of iterators
NullPointerException
- if iterators array is or contains nullpublic CollatingIterator(Comparator comp, Collection iterators)
CollatingIterator
that will use the
specified comparator to provide ordered iteration over the collection
of iterators.
comp
- the comparator to use to sort, or null to use natural sort orderiterators
- the collection of iterators
NullPointerException
- if the iterators collection is or contains null
ClassCastException
- if the iterators collection contains an
element that's not an Iterator
Method Detail |
---|
public void addIterator(Iterator iterator)
Iterator
to the iterators being collated.
iterator
- the iterator to add to the collation, must not be null
IllegalStateException
- if iteration has started
NullPointerException
- if the iterator is nullpublic void setIterator(int index, Iterator iterator)
index
- index of the Iterator to replaceiterator
- Iterator to place at the given index
IndexOutOfBoundsException
- if index < 0 or index > size()
IllegalStateException
- if iteration has started
NullPointerException
- if the iterator is nullpublic List getIterators()
public Comparator getComparator()
Comparator
by which collatation occurs.
public void setComparator(Comparator comp)
Comparator
by which collation occurs.
IllegalStateException
- if iteration has startedpublic boolean hasNext()
true
if any child iterator has remaining elements.
hasNext
in interface Iterator
public Object next() throws NoSuchElementException
next
in interface Iterator
NoSuchElementException
- if no child iterator has any more elementspublic void remove()
remove
in interface Iterator
IllegalStateException
- if there is no last returned element,
or if the last returned element has already been removed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |