cusack.hcg.events

Class BaseEvent<S extends PuzzleInstance>

java.lang.Object

cusack.hcg.events.BaseEvent<S>

All Implemented Interfaces:

Event<S>

Direct Known Subclasses:

ClickCheckButtonEvent, GenericEvent, GraphEditEvent, GraphMovedEvent, InvalidEvent, MultiEdgeEvent, MultiVertexEvent, NamedSubGraphEvent, RecycleEvent, RedoEvent, ResetVertexLocationsEvent, SingleVertexEvent, SubgraphGraphEditEvent, SubmitButtonClickedEvent, TryItButtonEvent, UndoEvent, UndoRecycleEvent, UndoResetVertexLocationsEvent

public abstract class BaseEvent<S extends PuzzleInstance>
extends java.lang.Object
implements Event<S>

Top of the event food chain. All events eventually extend event. This class was rewritten in Feb 2010. Although I am not using the best OOP principles, this seems to be the best way to accomplish the main goal: Make it easy to encode and decode events. The bad part about it is for any new subclass of BaseEvent created that needs to be encoded/decoded, it has to be added here, which is sort of stupid. But it is the simplest way to keep track of the encodings in one place.

Author:

Eric 'Fats' DePree, Modified by Chuck Cusack, Feb 2010.

Constructor Summary

Constructors

Constructor and Description
BaseEvent(S game)

Method Summary

Modifier and Type	Method and Description
boolean	canUserGenerate()
void	clearComments()
java.lang.String	encodeEvent() Encode the event by a String found in the map followed by a space followed by any other data.
static java.lang.String	encodeEvents(java.util.List<Event<?>> events)
boolean	equals(java.lang.Object other)
java.lang.String	getAfterActionComment() This method is different from the others--If the after comment is not set, we return null--this way we can prevent the "Next" button from showing up if the comment is null.
java.lang.String	getBeforeActionComment()
java.lang.String	getBetweenActionComment()
abstract java.lang.String	getDefaultBeforeActionComment()
abstract java.lang.String	getDefaultBetweenActionComment()
abstract java.lang.String	getDefaultIntroductoryComment()
abstract java.lang.String	getEventName() Return the name of the event for printing.
S	getGame()
java.lang.String	getIntroductoryComment()
Event<S>	getInverseEvent()
abstract java.lang.String	getPrintableDetails() Return the details for printing (e.g.
java.lang.String	getRealAfterActionComment() Almost the normal getter except it returns "" instead of null if it is null.
java.lang.String	getRealBeforeActionComment() Almost the normal getter except it returns "" instead of null if it is null.
java.lang.String	getRealBetweenActionComment() Almost the normal getter except it returns "" instead of null if it is null.
java.lang.String	getRealIntroductoryComment() Almost the normal getter except it returns "" instead of null if it is null.
long	getTimeSinceFirstEvent()
int	hashCode() Lazy, but I think it will work.
abstract boolean	involvesMultipleVertices()
abstract boolean	involvesOneVertex()
boolean	isCreatedFromConstructor()
boolean	isSameEvent(Event e)
boolean	modifiedGraph()
boolean	modifiedPuzzle()
void	performInverseEvent()
void	performTakebackEvent()
void	setAfterActionComment(java.lang.String afterActionComment)
void	setBeforeActionComment(java.lang.String beforeActionComment)
void	setBetweenActionComment(java.lang.String betweenActionComment)
void	setCreatedFromConstructor(boolean createdFromConstructor)
void	setGame(S game)
void	setIntroductoryComment(java.lang.String moveOverview)
void	setTimeSinceFirstEvent(long timeSinceFirstEvent)
java.lang.String	toString()
java.lang.String	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

BaseEvent

public BaseEvent(S game)

Method Detail

clearComments

public void clearComments()

Specified by:

clearComments in interface Event<S extends PuzzleInstance>

getDefaultIntroductoryComment

public abstract java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<S extends PuzzleInstance>

getDefaultBeforeActionComment

public abstract java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<S extends PuzzleInstance>

getDefaultBetweenActionComment

public abstract java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<S extends PuzzleInstance>

involvesOneVertex

public abstract boolean involvesOneVertex()

Specified by:

involvesOneVertex in interface Event<S extends PuzzleInstance>

involvesMultipleVertices

public abstract boolean involvesMultipleVertices()

Specified by:

involvesMultipleVertices in interface Event<S extends PuzzleInstance>

getEventName

public abstract java.lang.String getEventName()

Return the name of the event for printing.

Returns:

getPrintableDetails

public abstract java.lang.String getPrintableDetails()

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

Returns:

performInverseEvent

public void performInverseEvent()

Specified by:

performInverseEvent in interface Event<S extends PuzzleInstance>

performTakebackEvent

public void performTakebackEvent()

Specified by:

performTakebackEvent in interface Event<S extends PuzzleInstance>

encodeEvent

public java.lang.String encodeEvent()

Description copied from interface: Event

Encode the event by a String found in the map followed by a space followed by any other data. If there is no map entry, return the empty string, whether or not there is any data.

Specified by:

encodeEvent in interface Event<S extends PuzzleInstance>

Returns:

canUserGenerate

public boolean canUserGenerate()

Specified by:

canUserGenerate in interface Event<S extends PuzzleInstance>

getGame

public S getGame()

Specified by:

getGame in interface Event<S extends PuzzleInstance>

setGame

public void setGame(S game)

Specified by:

setGame in interface Event<S extends PuzzleInstance>

modifiedGraph

public boolean modifiedGraph()

Specified by:

modifiedGraph in interface Event<S extends PuzzleInstance>

modifiedPuzzle

public boolean modifiedPuzzle()

Specified by:

modifiedPuzzle in interface Event<S extends PuzzleInstance>

getInverseEvent

public Event<S> getInverseEvent()

Specified by:

getInverseEvent in interface Event<S extends PuzzleInstance>

getTimeSinceFirstEvent

public long getTimeSinceFirstEvent()

Specified by:

getTimeSinceFirstEvent in interface Event<S extends PuzzleInstance>

getIntroductoryComment

public java.lang.String getIntroductoryComment()

Specified by:

getIntroductoryComment in interface Event<S extends PuzzleInstance>

getRealIntroductoryComment

public java.lang.String getRealIntroductoryComment()

Almost the normal getter except it returns "" instead of null if it is null.

Specified by:

getRealIntroductoryComment in interface Event<S extends PuzzleInstance>

setIntroductoryComment

public void setIntroductoryComment(java.lang.String moveOverview)

Specified by:

setIntroductoryComment in interface Event<S extends PuzzleInstance>

getBeforeActionComment

public java.lang.String getBeforeActionComment()

Specified by:

getBeforeActionComment in interface Event<S extends PuzzleInstance>

getRealBeforeActionComment

public java.lang.String getRealBeforeActionComment()

Almost the normal getter except it returns "" instead of null if it is null.

Specified by:

getRealBeforeActionComment in interface Event<S extends PuzzleInstance>

setBeforeActionComment

public void setBeforeActionComment(java.lang.String beforeActionComment)

Specified by:

setBeforeActionComment in interface Event<S extends PuzzleInstance>

getBetweenActionComment

public java.lang.String getBetweenActionComment()

Specified by:

getBetweenActionComment in interface Event<S extends PuzzleInstance>

getRealBetweenActionComment

public java.lang.String getRealBetweenActionComment()

Almost the normal getter except it returns "" instead of null if it is null.

Specified by:

getRealBetweenActionComment in interface Event<S extends PuzzleInstance>

setBetweenActionComment

public void setBetweenActionComment(java.lang.String betweenActionComment)

Specified by:

setBetweenActionComment in interface Event<S extends PuzzleInstance>

getAfterActionComment

public java.lang.String getAfterActionComment()

This method is different from the others--If the after comment is not set, we return null--this way we can prevent the "Next" button from showing up if the comment is null.

Specified by:

getAfterActionComment in interface Event<S extends PuzzleInstance>

getRealAfterActionComment

public java.lang.String getRealAfterActionComment()

Almost the normal getter except it returns "" instead of null if it is null.

Specified by:

getRealAfterActionComment in interface Event<S extends PuzzleInstance>

setAfterActionComment

public void setAfterActionComment(java.lang.String afterActionComment)

Specified by:

setAfterActionComment in interface Event<S extends PuzzleInstance>

setTimeSinceFirstEvent

public void setTimeSinceFirstEvent(long timeSinceFirstEvent)

Specified by:

setTimeSinceFirstEvent in interface Event<S extends PuzzleInstance>

hashCode

public int hashCode()

Lazy, but I think it will work. I include the name of the class in case an event's encodeEvent returns the empty string.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringWithoutTime

public java.lang.String toStringWithoutTime()

Specified by:

toStringWithoutTime in interface Event<S extends PuzzleInstance>

isSameEvent

public boolean isSameEvent(Event e)

Specified by:

isSameEvent in interface Event<S extends PuzzleInstance>

encodeEvents

public static java.lang.String encodeEvents(java.util.List<Event<?>> events)

isCreatedFromConstructor

public boolean isCreatedFromConstructor()

setCreatedFromConstructor

public void setCreatedFromConstructor(boolean createdFromConstructor)