model

Class CycleHandler

java.lang.Object

model.CycleHandler

public final class CycleHandler
extends Object

Singleton class that handle the cycles of an LPS framework. Only called by the static method getInstance().

Author:

Alexandre Camus

See Also:

getInstance()

Field Summary

Fields

Modifier and Type	Field and Description
private RuleSet	events
private static CycleHandler	instance
private CycleState	myState

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CycleHandler() Constructor of the class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(Rule event) Adds the specified event/action to the events set.
RuleSet	getEvents() Gets the events/actions that have been decided to be performed during the previous cycle.
static CycleHandler	getInstance() Gets the only object of this singleton class.
void	handlerMethod(String NAME) Sends the request to the current state to operate its behavior.
void	setEvents(RuleSet events) Sets the events/actions that have been decided to be performed during the previous cycle.
void	setState(CycleState NEW_STATE) Sets the state from which the CycleHandler will call the handlerMethod This allows states to terminate and send a request to the CycleHandler to go to the specified and next state.

Methods inherited from class java.lang.Object

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

Field Detail

instance

private static volatile CycleHandler instance

myState

private CycleState myState

events

private RuleSet events

Constructor Detail

CycleHandler

private CycleHandler()

Constructor of the class. To be not used by itself as the class is a singleton. Use the specific method getInstance() instead.

See Also:

getInstance()

Method Detail

getInstance

public static CycleHandler getInstance()

Gets the only object of this singleton class. Use it as a static method.

Returns:

instance the only object of this class. If the object was not already created it will create it.

setState

public void setState(CycleState NEW_STATE)

Sets the state from which the CycleHandler will call the handlerMethod

This allows states to terminate and send a request to the CycleHandler to go to the specified and next state.

Parameters:

NEW_STATE - the next step of the cycle.

handlerMethod

public void handlerMethod(String NAME)

Sends the request to the current state to operate its behavior.

This method should be the only way to perform the action of a state. It calls the handlerMethod() of the interface CycleState which every state implements.

Parameters:

NAME - the name of the step. It has no use except to debug.

getEvents

public RuleSet getEvents()

Gets the events/actions that have been decided to be performed during the previous cycle.

See a LPS documentation for more details on cycles and actions/events.

Returns:

an object RuleSet containing the events triggered during the last cycle.

setEvents

public void setEvents(RuleSet events)

Sets the events/actions that have been decided to be performed during the previous cycle.

This method is basically used by a cycle during its final step to prepare the next cycle.

See a LPS documentation for more details on cycles and actions/events.

Parameters:

events - the events under the form of a RuleSet object, triggered during the last cycle.

addEvent

public void addEvent(Rule event)

Adds the specified event/action to the events set.

This method is basically used when a user adds an event.

See a LPS documentation for more details on cycles and actions/events.

Parameters:

event - the event under the form of a Rule object.