net.thestump.ghronos.timing
Class Boggle

java.lang.Object
  net.thestump.ghronos.timing.TimingStyle
      net.thestump.ghronos.timing.Boggle

All Implemented Interfaces:

superwaba.ext.xplat.io.Storable

public class Boggle

extends TimingStyle

Provides a timing style suitable for playing Boggle

Author:

Christopher C. Stump

Field Summary

static byte	ID Storable & TimingStyle id
static java.lang.String	NAME Timing style name

Fields inherited from class net.thestump.ghronos.timing.TimingStyle

appliedToBottomClock, appliedToTopClock, toStart, toStop

Constructor Summary

Boggle()

Method Summary

void	execute(Clock topClock, Clock bottomClock) Applies the timing style to the appropriate clocks on a clock switch
java.lang.String	getDescription() Gets a description of this timing style which is used to display information about the timing style in a help dialog
byte	getID()
superwaba.ext.xplat.io.Storable	getInstance()
void	onRegister(Clock topClock, Clock bottomClock) Called when this TimingStyle is registered with the Mediator.
void	onUnRegister(Clock topClock, Clock bottomClock) Called when this TimingStyle is unregistered with the Mediator (when another TimingStyle is registered).
java.lang.String	toString()

Methods inherited from class net.thestump.ghronos.timing.TimingStyle

applyTo, evaluate, isAppliedTo, loadState, saveState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final byte ID

Storable & TimingStyle id

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Timing style name

See Also:

Constant Field Values

Constructor Detail

Boggle

public Boggle()

Method Detail

getID

public byte getID()

Specified by:

getID in interface superwaba.ext.xplat.io.Storable

Specified by:

getID in class TimingStyle

toString

public java.lang.String toString()

getInstance

public superwaba.ext.xplat.io.Storable getInstance()

Specified by:

getInstance in interface superwaba.ext.xplat.io.Storable

Specified by:

getInstance in class TimingStyle

getDescription

public java.lang.String getDescription()

Description copied from class: TimingStyle

Gets a description of this timing style which is used to display information about the timing style in a help dialog

Specified by:

getDescription in class TimingStyle

Returns:

A brief description of how the timing style operates.

onUnRegister

public void onUnRegister(Clock topClock,
                         Clock bottomClock)

Description copied from class: TimingStyle

Called when this TimingStyle is unregistered with the Mediator (when another TimingStyle is registered). Is a place holder to do work before just before the timing style is trashed. Does nothing by default.

Overrides:

onUnRegister in class TimingStyle

Parameters:

topClock -

bottomClock -

onRegister

public void onRegister(Clock topClock,
                       Clock bottomClock)

Description copied from class: TimingStyle

Called when this TimingStyle is registered with the Mediator. Is a place holder to do work before just before the timing style is actually used. Does nothing by default. Note that this method IS NOT called when a timing style is recalled from the database

Overrides:

onRegister in class TimingStyle

Parameters:

topClock -

bottomClock -

execute

public void execute(Clock topClock,
                    Clock bottomClock)

Description copied from class: TimingStyle

Applies the timing style to the appropriate clocks on a clock switch

Specified by:

execute in class TimingStyle

Parameters:

topClock - The application's top clock

bottomClock - The application's bottom clock