xxl.cursors
Class Sequentializer

java.lang.Object
  |
  +--xxl.cursors.Sequentializer

public class Sequentializer

extends java.lang.Object

implements Cursor

The Sequentializer concatenates n input-Cursors to a single Cursor.

Field Summary

protected Cursor	cursor
protected Cursor	iteratorsCursor
protected Cursor	updateCursor

Constructor Summary

Sequentializer(Cursor iteratorsCursor)
Creates a new Sequentializer.

Sequentializer(java.util.Iterator iteratorsCursor)
Creates a new Sequentializer.

Sequentializer(java.util.Iterator[] iterators)
Creates a new Sequentializer.

Sequentializer(java.util.Iterator iterator, Function function)
Creates a new Sequentializer.

Sequentializer(java.util.Iterator iterator0, java.util.Iterator iterator1)
Creates a new Sequentializer.

Sequentializer(PeekIterator iteratorsCursor)
Creates a new Sequentializer.

Method Summary

void	close() Closes the Cursor.
boolean	hasNext() Returns true if the iteration has more elements.
java.lang.Object	next() Returns the next element in the iteration.
java.lang.Object	peek() Shows the next element in the iteration without removing it.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).
void	reset() Resets the Cursor to its initial state.
boolean	supportsPeek() Returns true if the peek operation is supported by this PeekIterator.
void	update(java.lang.Object object) Replaces the object that was returned by the last call to next() or peek().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iteratorsCursor

protected Cursor iteratorsCursor

cursor

protected Cursor cursor

updateCursor

protected Cursor updateCursor

Constructor Detail

Sequentializer

public Sequentializer(java.util.Iterator iterator0,
                      java.util.Iterator iterator1)

Creates a new Sequentializer.

Parameters:

iterator0 - first input-Iterator

iterator1 - second input-Iterator

Sequentializer

public Sequentializer(java.util.Iterator[] iterators)

Creates a new Sequentializer.

Parameters:

iterator - input-array of Iterators

Sequentializer

public Sequentializer(java.util.Iterator iterator,
                      Function function)

Creates a new Sequentializer.

Parameters:

iterator - first input-Iterator

function - parameterless function returning the second input-Iterator on demand. This function is invoked after the first input-Iterator has been processed completely.

Sequentializer

public Sequentializer(Cursor iteratorsCursor)

Creates a new Sequentializer.

Parameters:

iteratorsCursor - input-Cursor of iterators

Sequentializer

public Sequentializer(java.util.Iterator iteratorsCursor)

Creates a new Sequentializer.

Parameters:

iteratorsCursor - input-Iterator of iterators

Sequentializer

public Sequentializer(PeekIterator iteratorsCursor)

Creates a new Sequentializer.

Parameters:

iteratorsCursor - input-PeekIterator of iterators

Method Detail

close

public void close()
           throws java.lang.UnsupportedOperationException

Closes the Cursor. Signals the cursor to cleanup resources, close files, etc. After a call to close() calls to methods like next() or peek() are not guarantied to yield proper results.

Specified by:

close in interface Cursor

hasNext

public boolean hasNext()

Returns true if the iteration has more elements.

Specified by:

hasNext in interface Cursor

Returns:

true if the iterator has more elements.

next

public java.lang.Object next()
                      throws java.util.NoSuchElementException

Returns the next element in the iteration.

Specified by:

next in interface Cursor

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - iteration has no more elements.

peek

public java.lang.Object peek()
                      throws java.lang.UnsupportedOperationException

Shows the next element in the iteration without removing it.

Specified by:

peek in interface Cursor

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - iteration has no more elements.

java.lang.UnsupportedOperationException - if the peek operation is not supported by this PeekIterator.

remove

public void remove()
            throws java.lang.UnsupportedOperationException

Removes from the underlying collection the last element returned by the iterator (optional operation).

Specified by:

remove in interface Cursor

Throws:

java.lang.IllegalStateException - if the next method has not yet been called, or the remove method has already been cal after the last call to the next method.

java.lang.UnsupportedOperationException - if the remove operation not supported by this PeekIterator.

reset

public void reset()
           throws java.lang.UnsupportedOperationException

Resets the Cursor to its initial state.

Specified by:

reset in interface Cursor

supportsPeek

public boolean supportsPeek()

Returns true if the peek operation is supported by this PeekIterator.

Specified by:

supportsPeek in interface Cursor

Returns:

true if the peek operation is supported by this PeekIterator.

update

public void update(java.lang.Object object)
            throws java.lang.UnsupportedOperationException

Replaces the object that was returned by the last call to next() or peek(). This operation must not be called after a call to hasNext(). It should foow a call to next() or peek().

Specified by:

update in interface Cursor

Parameters:

object - the object that replaces the object returned by the last call to next() or peek()