java.lang.Object | |
↳ | org.apache.commons.collections.iterators.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()
.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new
CollatingIterator . | |||||||||||
Constructs a new
CollatingIterator that will used the
specified comparator for ordering. | |||||||||||
Constructs a new
CollatingIterator that will used the
specified comparator for ordering and have the specified initial
capacity. | |||||||||||
Constructs a new
CollatingIterator that will use the
specified comparator to provide ordered iteration over the two
given iterators. | |||||||||||
Constructs a new
CollatingIterator that will use the
specified comparator to provide ordered iteration over the array
of iterators. | |||||||||||
Constructs a new
CollatingIterator that will use the
specified comparator to provide ordered iteration over the collection
of iterators. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds the given
Iterator to the iterators being collated. | |||||||||||
Gets the
Comparator by which collatation occurs. | |||||||||||
Gets the list of Iterators (unmodifiable).
| |||||||||||
Returns
true if any child iterator has remaining elements. | |||||||||||
Returns the next ordered element from a child iterator.
| |||||||||||
Removes the last returned element from the child iterator that
produced it.
| |||||||||||
Sets the
Comparator by which collation occurs. | |||||||||||
Sets the iterator at the given index.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.util.Iterator
|
Constructs a new CollatingIterator
. Natural sort order
will be used, and child iterators will have to be manually added
using the addIterator(Iterator)
method.
Constructs a new 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 order |
---|
Constructs a new 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 order |
---|---|
initIterCapacity | the initial capacity for the internal list of child iterators |
Constructs a new 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 order |
---|---|
a | the first child ordered iterator |
b | the second child ordered iterator |
NullPointerException | if either iterator is null |
---|
Constructs a new 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 order |
---|---|
iterators | the array of iterators |
NullPointerException | if iterators array is or contains null |
---|
Constructs a new 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 order |
---|---|
iterators | 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
|
Adds the given 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 null |
Gets the list of Iterators (unmodifiable).
Returns true
if any child iterator has remaining elements.
Returns the next ordered element from a child iterator.
NoSuchElementException | if no child iterator has any more elements |
---|
Removes the last returned element from the child iterator that produced it.
IllegalStateException | if there is no last returned element, or if the last returned element has already been removed |
---|
Sets the Comparator
by which collation occurs.
IllegalStateException | if iteration has started |
---|
Sets the iterator at the given index.
index | index of the Iterator to replace |
---|---|
iterator | Iterator to place at the given index |
IndexOutOfBoundsException | if index < 0 or index > size() |
---|---|
IllegalStateException | if iteration has started |
NullPointerException | if the iterator is null |