cusack.hcg.events

Class SingleVertexEvent<S extends PuzzleInstance>

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.SingleVertexEvent<S>

All Implemented Interfaces:

Event<S>, OneVertexEvent

Direct Known Subclasses:

LightDownEvent, LightDownNeighborhoodEvent, LightUpEvent, LightUpNeighborhoodEvent, PebblePlacedEvent, PebbleRemovedEvent, PortalLordSetValueEvent, VertexChosenEvent, VertexDeselectedEvent, VertexSelectedEvent, VertexUnchosenEvent

public abstract class SingleVertexEvent<S extends PuzzleInstance>
extends BaseEvent<S>
implements OneVertexEvent

An expanded event that contains a vertex. The main purpose of this is to avoid code duplication in sub-events

Author:

Eric DePree, Modified by Chuck Cusack, Feb 2010.

Constructor Summary

Constructors

Constructor and Description
SingleVertexEvent(S game)
SingleVertexEvent(S game, Vertex vertex)

Method Summary

Modifier and Type	Method and Description
void	decodeData(java.lang.String data) Data should be the index of a vertex.
java.lang.String	getPrintableDetails() Return the details for printing (e.g.
Vertex	getVertex()
boolean	involvesMultipleVertices()
boolean	involvesOneVertex()
boolean	isSameEvent(Event e)
void	setVertex(Vertex vertex)

Methods inherited from class cusack.hcg.events.BaseEvent

canUserGenerate, clearComments, encodeEvent, encodeEvents, equals, getAfterActionComment, getBeforeActionComment, getBetweenActionComment, getDefaultBeforeActionComment, getDefaultBetweenActionComment, getDefaultIntroductoryComment, getEventName, getGame, getIntroductoryComment, getInverseEvent, getRealAfterActionComment, getRealBeforeActionComment, getRealBetweenActionComment, getRealIntroductoryComment, getTimeSinceFirstEvent, hashCode, isCreatedFromConstructor, 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

Methods inherited from interface cusack.hcg.events.Event

performEvent, takebackSideEffects

Constructor Detail

SingleVertexEvent

public SingleVertexEvent(S game)

SingleVertexEvent

public SingleVertexEvent(S game,
                         Vertex vertex)

Method Detail

getVertex

public Vertex getVertex()

Specified by:

getVertex in interface OneVertexEvent

Returns:

the v

setVertex

public void setVertex(Vertex vertex)

Specified by:

setVertex in interface OneVertexEvent

decodeData

public final void decodeData(java.lang.String data)

Data should be the index of a vertex.

isSameEvent

public boolean isSameEvent(Event e)

Specified by:

isSameEvent in interface Event<S extends PuzzleInstance>

Overrides:

isSameEvent 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:

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>