cusack.hcg.events

Class AlgorithmResultEvent

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.GenericEvent<PuzzleInstance>

cusack.hcg.events.AlgorithmResultEvent

All Implemented Interfaces:

Event<PuzzleInstance>, RecordableEvent

public class AlgorithmResultEvent
extends GenericEvent<PuzzleInstance>
implements RecordableEvent

Constructor Summary

Constructors

Constructor and Description
AlgorithmResultEvent(PuzzleInstance game)
AlgorithmResultEvent(PuzzleInstance game, java.lang.String result)

Method Summary

Modifier and Type	Method and Description
boolean	canUserGenerate()
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.

Methods inherited from class cusack.hcg.events.GenericEvent

getDefaultBeforeActionComment, getDefaultBetweenActionComment, getDefaultIntroductoryComment, involvesMultipleVertices, involvesOneVertex, performEvent, takebackSideEffects

Methods inherited from class cusack.hcg.events.BaseEvent

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

AlgorithmResultEvent

public AlgorithmResultEvent(PuzzleInstance game)

AlgorithmResultEvent

public AlgorithmResultEvent(PuzzleInstance game,
                            java.lang.String result)

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.

Overrides:

inverseEvent in class GenericEvent<PuzzleInstance>

Returns:

getEventName

public java.lang.String getEventName()

Description copied from class: BaseEvent

Return the name of the event for printing.

Overrides:

getEventName in class GenericEvent<PuzzleInstance>

Returns:

getPrintableDetails

public java.lang.String getPrintableDetails()

Description copied from class: BaseEvent

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

Overrides:

getPrintableDetails in class GenericEvent<PuzzleInstance>

Returns:

canUserGenerate

public boolean canUserGenerate()

Specified by:

canUserGenerate in interface Event<PuzzleInstance>

Overrides:

canUserGenerate in class BaseEvent<PuzzleInstance>