cusack.hcg.events

Class InvalidEvent<S extends PuzzleInstance>

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.InvalidEvent<S>

All Implemented Interfaces:

Event<S>

public class InvalidEvent<S extends PuzzleInstance>
extends BaseEvent<S>

This is an unspecified event. It is used for 2 purposes: 1. For classes that do not want to worry about encoding/decoding. They can subclass this. 2. Special events that do not necessarily have special outcomes, but for which we need to tell listeners that something happened. Generally, this is used when we know something has changed and a view needs to redraw. We assume these events do not modify the graph or game. If the game or graph is modified, a more specific event should be used.

Author:

Chuck Cusack, Feb 2010

Constructor Summary

Constructors

Constructor and Description
InvalidEvent(S 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<S>	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

InvalidEvent

public InvalidEvent(S game)

Method Detail

inverseEvent

public Event<S> 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:

getDefaultIntroductoryComment

public java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<S extends PuzzleInstance>

Specified by:

getDefaultIntroductoryComment in class BaseEvent<S extends PuzzleInstance>

getDefaultBeforeActionComment

public java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<S extends PuzzleInstance>

Specified by:

getDefaultBeforeActionComment in class BaseEvent<S extends PuzzleInstance>

getDefaultBetweenActionComment

public java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<S extends PuzzleInstance>

Specified by:

getDefaultBetweenActionComment in class BaseEvent<S extends PuzzleInstance>

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<S extends PuzzleInstance>

Returns:

performEvent

public void performEvent()

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.

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<S extends PuzzleInstance>

Returns:

involvesOneVertex

public boolean involvesOneVertex()

Specified by:

involvesOneVertex in interface Event<S extends PuzzleInstance>

Specified by:

involvesOneVertex in class BaseEvent<S extends PuzzleInstance>

involvesMultipleVertices

public boolean involvesMultipleVertices()

Specified by:

involvesMultipleVertices in interface Event<S extends PuzzleInstance>

Specified by:

involvesMultipleVertices in class BaseEvent<S extends PuzzleInstance>