cusack.hcg.events.game

Class UndoEvent

java.lang.Object

cusack.hcg.events.BaseEvent<PuzzleInstance>

cusack.hcg.events.game.UndoEvent

All Implemented Interfaces:

Event<PuzzleInstance>, UndoOrRedoEvent, RecordableEvent

public class UndoEvent
extends BaseEvent<PuzzleInstance>
implements RecordableEvent, UndoOrRedoEvent

Constructor Summary

Constructors

Constructor and Description
UndoEvent(PuzzleInstance game)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultBeforeActionComment()
java.lang.String	getDefaultBetweenActionComment()
java.lang.String	getDefaultIntroductoryComment()
java.lang.String	getEventName() Return the name of the event for printing.
java.lang.String	getPrintableDetails() Return the details for printing (e.g.
Event<PuzzleInstance>	inverseEvent() This is the method that will be called by the public method getInverseEvent.
boolean	involvesMultipleVertices()
boolean	involvesOneVertex()
void	performEvent()
void	takebackSideEffects() Implement anything special that has to be done after a move has been taken back.

Methods inherited from class cusack.hcg.events.BaseEvent

canUserGenerate, clearComments, encodeEvent, encodeEvents, equals, getAfterActionComment, getBeforeActionComment, getBetweenActionComment, getGame, getIntroductoryComment, getInverseEvent, getRealAfterActionComment, getRealBeforeActionComment, getRealBetweenActionComment, getRealIntroductoryComment, getTimeSinceFirstEvent, hashCode, isCreatedFromConstructor, isSameEvent, modifiedGraph, modifiedPuzzle, performInverseEvent, performTakebackEvent, setAfterActionComment, setBeforeActionComment, setBetweenActionComment, setCreatedFromConstructor, setGame, setIntroductoryComment, setTimeSinceFirstEvent, toString, toStringWithoutTime

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UndoEvent

public UndoEvent(PuzzleInstance game)

Method Detail

inverseEvent

public Event<PuzzleInstance> inverseEvent()

Description copied from class: BaseEvent

This is the method that will be called by the public method getInverseEvent. Although a bit weird, it is done this way because that method sets the time of the inverse event, so we want them to call that one. We don't want every class to have to remember to do that part.

Returns:

performEvent

public void performEvent()

Specified by:

performEvent in interface Event<PuzzleInstance>

getDefaultIntroductoryComment

public java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<PuzzleInstance>

Specified by:

getDefaultIntroductoryComment in class BaseEvent<PuzzleInstance>

getDefaultBeforeActionComment

public java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBeforeActionComment in class BaseEvent<PuzzleInstance>

getDefaultBetweenActionComment

public java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBetweenActionComment in class BaseEvent<PuzzleInstance>

getEventName

public java.lang.String getEventName()

Description copied from class: BaseEvent

Return the name of the event for printing.

Specified by:

getEventName in class BaseEvent<PuzzleInstance>

Returns:

getPrintableDetails

public java.lang.String getPrintableDetails()

Description copied from class: BaseEvent

Return the details for printing (e.g. vertex indices).

Specified by:

getPrintableDetails in class BaseEvent<PuzzleInstance>

Returns:

takebackSideEffects

public void takebackSideEffects()

Description copied from interface: Event

Implement anything special that has to be done after a move has been taken back. For instance, if it is a pebbling move, a vertex might need to be listed as uncovered, but that isn't a normal part of undoing a pebble move.

Specified by:

takebackSideEffects in interface Event<PuzzleInstance>

involvesOneVertex

public boolean involvesOneVertex()

Specified by:

involvesOneVertex in interface Event<PuzzleInstance>

Specified by:

involvesOneVertex in class BaseEvent<PuzzleInstance>

involvesMultipleVertices

public boolean involvesMultipleVertices()

Specified by:

involvesMultipleVertices in interface Event<PuzzleInstance>

Specified by:

involvesMultipleVertices in class BaseEvent<PuzzleInstance>