eu.hgross.blaubot.core.statemachine.states

Class PeasantState

java.lang.Object

eu.hgross.blaubot.core.statemachine.states.PeasantState

All Implemented Interfaces:

IBlaubotState, IBlaubotSubordinatedState

public class PeasantState
extends java.lang.Object
implements IBlaubotState, IBlaubotSubordinatedState

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeasantState.ConnectionAccomplishmentType

Constructor Summary

Constructors

Constructor and Description
PeasantState(IBlaubotConnection kingConnection, PeasantState.ConnectionAccomplishmentType connectionAccomplishmentType)

Method Summary

Modifier and Type	Method and Description
PeasantState.ConnectionAccomplishmentType	getConnectionAccomplishmentType()
IBlaubotConnection	getKingConnection()
java.lang.String	getKingUniqueId()
void	handleState(StateMachineSession session) Gets called if this state was set as currentState by the ConnectionStateMachine.
IBlaubotState	onAdminMessage(AbstractAdminMessage adminMessage) Gets called when an AbstractAdminMessage was received.
IBlaubotState	onConnectionClosed(IBlaubotConnection connection) Gets called if a previously established connection from a remote IBlaubotDevice was closed due to an exception or intentionally.
IBlaubotState	onConnectionEstablished(IBlaubotConnection connection) Gets called if a new connection from a remote IBlaubotDevice was established.
IBlaubotState	onDeviceDiscoveryEvent(AbstractBlaubotDeviceDiscoveryEvent discoveryEvent) Gets called if a IBlaubotBeacon discovered a IBlaubotDevice.
IBlaubotState	onTimeoutEvent(AbstractTimeoutStateMachineEvent timeoutEvent) This is a helper for Timeout-Events needed for some IBlaubotStates.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PeasantState

public PeasantState(IBlaubotConnection kingConnection,
                    PeasantState.ConnectionAccomplishmentType connectionAccomplishmentType)

Parameters:

kingConnection - the connection to our king

connectionAccomplishmentType - information about how the connection was accomplished

Method Detail

getConnectionAccomplishmentType

public PeasantState.ConnectionAccomplishmentType getConnectionAccomplishmentType()

Returns:

VOLUNTARILY if we connected to the king from Free state, BOWED_DOWN if we connected to the king due to a BowDownToNewKingAdminMessage

onConnectionEstablished

public IBlaubotState onConnectionEstablished(IBlaubotConnection connection)

Description copied from interface: IBlaubotState

Gets called if a new connection from a remote IBlaubotDevice was established.

Specified by:

onConnectionEstablished in interface IBlaubotState

Parameters:

connection - the established connection

Returns:

the next state based on this event, could be a new state or the identity

onConnectionClosed

public IBlaubotState onConnectionClosed(IBlaubotConnection connection)

Description copied from interface: IBlaubotState

Gets called if a previously established connection from a remote IBlaubotDevice was closed due to an exception or intentionally.

Specified by:

onConnectionClosed in interface IBlaubotState

Parameters:

connection - the closed connection

Returns:

the next state based on this event, could be a new state or the identity

onDeviceDiscoveryEvent

public IBlaubotState onDeviceDiscoveryEvent(AbstractBlaubotDeviceDiscoveryEvent discoveryEvent)

Description copied from interface: IBlaubotState

Gets called if a IBlaubotBeacon discovered a IBlaubotDevice. Note: For each discoverable IBlaubotState a corresponding AbstractBlaubotDeviceDiscoveryEvent subclass can be found in the de.hsrm.blaubot.statemachine.events package.

Specified by:

onDeviceDiscoveryEvent in interface IBlaubotState

Parameters:

discoveryEvent - the discovery event.

Returns:

the next state based on this event, could be a new state or the identity

handleState

public void handleState(StateMachineSession session)

Description copied from interface: IBlaubotState

Gets called if this state was set as currentState by the ConnectionStateMachine.

Specified by:

handleState in interface IBlaubotState

Parameters:

session - a session object with access to the relevant Blaubot components.

onAdminMessage

public IBlaubotState onAdminMessage(AbstractAdminMessage adminMessage)

Description copied from interface: IBlaubotState

Gets called when an AbstractAdminMessage was received.

Specified by:

onAdminMessage in interface IBlaubotState

Parameters:

adminMessage - the received admin message

Returns:

the next state based on this event, could be a new state or the identity

getKingUniqueId

public java.lang.String getKingUniqueId()

Specified by:

getKingUniqueId in interface IBlaubotSubordinatedState

Returns:

this subordinate's king uniqueId

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onTimeoutEvent

public IBlaubotState onTimeoutEvent(AbstractTimeoutStateMachineEvent timeoutEvent)

Description copied from interface: IBlaubotState

This is a helper for Timeout-Events needed for some IBlaubotStates. A IBlaubotState can subclass the AbstractTimeoutStateMachineEvent and push it to the ConnectionStateMachine. A timeout event contains the state that issued the timeout so a IBlaubotState can check if the timeout event belongs to himself or ignore it when this is not the case.

Specified by:

onTimeoutEvent in interface IBlaubotState

Parameters:

timeoutEvent - the occured event

Returns:

the next state based on this event, could be a new state or the identity

getKingConnection

public IBlaubotConnection getKingConnection()

Specified by:

getKingConnection in interface IBlaubotSubordinatedState

Returns:

the connection to this subordinate's king