org.kitteh.irc.client.library.feature.sts

Class MemoryStsMachine

java.lang.Object

org.kitteh.irc.client.library.feature.sts.MemoryStsMachine

All Implemented Interfaces:

StsMachine

public class MemoryStsMachine
extends Object
implements StsMachine

"Memory" prefix to distinguish implementation class from interface, because StsMachine isn't IStsMachine. This class implements our FSM in an in-memory fashion, using Java's data structures.

Constructor Summary

Constructors

Constructor and Description
MemoryStsMachine(StsStorageManager manager, Client.WithManagement client) Constructs the STS machine.

Method Summary

Modifier and Type	Method and Description
StsClientState	getCurrentState() Returns the current state in the enum that the state machine is operating in.
StsStorageManager	getStorageManager() Gets the persistence/storage manager.
void	setCurrentState(StsClientState newState) Changes the state of the FSM, triggering any state-specific work.
void	setStsPolicy(StsPolicy policy) Provides a key->value map of options and list of flags, making up the STS policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryStsMachine

public MemoryStsMachine(@Nonnull
                        StsStorageManager manager,
                        Client.WithManagement client)

Constructs the STS machine.

Parameters:

manager - STS manager

client - client

Method Detail

getCurrentState

@Nonnull
public StsClientState getCurrentState()

Description copied from interface: StsMachine

Returns the current state in the enum that the state machine is operating in.

Specified by:

getCurrentState in interface StsMachine

Returns:

one of STSClientState's members

setCurrentState

public void setCurrentState(@Nonnull
                            StsClientState newState)

Description copied from interface: StsMachine

Changes the state of the FSM, triggering any state-specific work.

Specified by:

setCurrentState in interface StsMachine

Parameters:

newState - a valid (non-UNKNOWN, non-null) state

getStorageManager

@Nonnull
public StsStorageManager getStorageManager()

Description copied from interface: StsMachine

Gets the persistence/storage manager.

Specified by:

getStorageManager in interface StsMachine

Returns:

the storage manager instance

setStsPolicy

public void setStsPolicy(@Nonnull
                         StsPolicy policy)

Description copied from interface: StsMachine

Provides a key->value map of options and list of flags, making up the STS policy.

It is expected the policy is valid at this stage.

Specified by:

setStsPolicy in interface StsMachine

Parameters:

policy - the valid STS policy