aos.jack.jak.cursor
Class TrueOnceCursor

java.lang.Object
  aos.jack.jak.util.Watchable
      aos.jack.jak.cursor.Cursor
          aos.jack.jak.cursor.TrueOnceCursor

All Implemented Interfaces:

ObservableInt

public class TrueOnceCursor

extends Cursor

Utility cursor that returns true only once between calls to reset().

Field Summary

Fields inherited from class aos.jack.jak.cursor.Cursor

FALSE, falseCursor, TRUE, trueCursor, UNKNOWN

Constructor Summary

TrueOnceCursor()

Method Summary

void	finished() This informs the cursor that it is not going to be used again.
boolean	next() Returns true the first time only.
Cursor	reset(aos.jack.jak.core.Generator g, int index) Reset the cursor.
void	undo() Undo tells the cursor to backtrack anything it has done.
boolean	unRegister(java.util.Observer o)

Methods inherited from class aos.jack.jak.cursor.Cursor

isTriggered, negate, register

Methods inherited from class aos.jack.jak.util.Watchable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

TrueOnceCursor

public TrueOnceCursor()

Method Detail

next

public boolean next()

Returns true the first time only.

Specified by:

next in class Cursor

reset

public Cursor reset(aos.jack.jak.core.Generator g,
                    int index)

Reset the cursor.

Overrides:

reset in class Cursor

Parameters:

g - The generator that generates an equivalent cursor

index - The index of the equivalent cursor in the generator.

Returns:

The reset cursor, or an equivalent one.

undo

public void undo()

Description copied from class: Cursor

Undo tells the cursor to backtrack anything it has done. It is a subset of the reset() functionality since it does not reinitialize the cursor. The only requirement is that any bindings made by the cursor are undone. The state of the cursor after the call is undefined. Most implementations will fail if next() is called after undo() without an intervening call to reset().

Overrides:

undo in class Cursor

finished

public void finished()

Description copied from class: Cursor

This informs the cursor that it is not going to be used again. This is typically used to clean up data strutures and to remove itself from any notification paths.

Overrides:

finished in class Cursor

unRegister

public boolean unRegister(java.util.Observer o)

Overrides:

unRegister in class Cursor