org.apache.commons.collections.iterators
Class CollatingIterator
java.lang.Object
org.apache.commons.collections.iterators.CollatingIterator
- Iterator
public class CollatingIterator
extends java.lang.Object
implements Iterator
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()
.
$Revision: 1.13 $ $Date: 2004/02/18 00:59:50 $- Rodney Waldhoff
- Stephen Colebourne
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, Iterator a, Iterator b) - Constructs a new
CollatingIterator that will use the
specified comparator to provide ordered iteration over the two
given iterators.
|
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, int initIterCapacity) - Constructs a new
CollatingIterator that will used the
specified comparator for ordering and have the specified initial
capacity.
|
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.
|
CollatingIterator
public CollatingIterator()
Constructs a new
CollatingIterator
. Natural sort order
will be used, and child iterators will have to be manually added
using the
addIterator(Iterator)
method.
CollatingIterator
public CollatingIterator(Comparator comp)
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
CollatingIterator
public CollatingIterator(Comparator comp,
Collection iterators)
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 orderiterators
- the collection of iterators
CollatingIterator
public 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.
comp
- the comparator to use to sort, or null to use natural sort ordera
- the first child ordered iteratorb
- the second child ordered iterator
CollatingIterator
public CollatingIterator(Comparator comp,
Iterator[] iterators)
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 orderiterators
- the array of iterators
CollatingIterator
public CollatingIterator(Comparator comp,
int initIterCapacity)
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 orderinitIterCapacity
- the initial capacity for the internal list
of child iterators
addIterator
public void addIterator(Iterator iterator)
Adds the given Iterator
to the iterators being collated.
iterator
- the iterator to add to the collation, must not be null
getComparator
public Comparator getComparator()
Gets the Comparator
by which collatation occurs.
getIterators
public List getIterators()
Gets the list of Iterators (unmodifiable).
- the unmodifiable list of iterators added
hasNext
public boolean hasNext()
Returns true
if any child iterator has remaining elements.
- true if this iterator has remaining elements
next
public Object next()
throws NoSuchElementException
Returns the next ordered element from a child iterator.
remove
public void remove()
Removes the last returned element from the child iterator that
produced it.
setComparator
public void setComparator(Comparator comp)
Sets the Comparator
by which collation occurs.
setIterator
public void setIterator(int index,
Iterator iterator)
Sets the iterator at the given index.
index
- index of the Iterator to replaceiterator
- Iterator to place at the given index
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.