xxl.visual
Class VisualCursor

java.lang.Object
  |
  +--xxl.visual.VisualIterator
        |
        +--xxl.visual.VisualPeekIterator
              |
              +--xxl.visual.VisualCursor

public class VisualCursor

extends VisualPeekIterator

This class extends VisualPeekIterator. Additional functionality are: update(), close() and reset(). General contract: If an Exception is thrown by a Cursor consequent calls to methods are not guarantied to produce correct results.

Inner classes inherited from class xxl.visual.VisualIterator

VisualIterator.IteratorFunction

Fields inherited from class xxl.visual.VisualIterator

children, inputOf, iterator, newIterator, parameters

Constructor Summary

VisualCursor(VisualIterator.IteratorFunction newCursor)

Method Summary

void	close() Closes the Cursor.
void	reset() Resets the Cursor to its initial state.
void	update(java.lang.Object object) Replaces the object that was returned by the last call to next() or peek().

Methods inherited from class xxl.visual.VisualPeekIterator

peek, supportsPeek

Methods inherited from class xxl.visual.VisualIterator

addInput, getParameters, hasNext, next, open, remove, removeInput, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualCursor

public VisualCursor(VisualIterator.IteratorFunction newCursor)

Method Detail

close

public void close()

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.

reset

public void reset()
           throws java.lang.UnsupportedOperationException

Resets the Cursor to its initial state.

update

public void update(java.lang.Object object)
            throws java.lang.IllegalStateException,
                   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 follow a call to next() or peek().

Parameters:

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