org.bitcoinj.protocols.channels

Class StateMachine<State extends Enum<State>>

java.lang.Object

org.bitcoinj.protocols.channels.StateMachine<State>

Type Parameters:

State - An enum of states to use

public class StateMachine<State extends Enum<State>>
extends Object

A class representing a state machine, with limited transitions between states.

Constructor Summary

Constructors

Constructor and Description
StateMachine(State startState, Multimap<State,State> transitions)

Method Summary

Modifier and Type	Method and Description
void	checkState(State... requiredStates) Checks that the machine is in one of the given states.
void	checkState(State requiredState) Checks that the machine is in the given state.
State	getState()
String	toString()
void	transition(State newState) Transitions to a new state, provided that the required transition exists

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachine

public StateMachine(State startState,
                    Multimap<State,State> transitions)

Method Detail

checkState

public void checkState(State requiredState)
                throws IllegalStateException

Checks that the machine is in the given state. Throws if it isn't.

Parameters:

requiredState -

Throws:

IllegalStateException

checkState

public void checkState(State... requiredStates)
                throws IllegalStateException

Checks that the machine is in one of the given states. Throws if it isn't.

Parameters:

requiredStates -

Throws:

IllegalStateException

transition

public void transition(State newState)
                throws IllegalStateException

Transitions to a new state, provided that the required transition exists

Parameters:

newState -

Throws:

IllegalStateException - If no state transition exists from oldState to newState

getState

public State getState()

toString

public String toString()

Overrides:

toString in class Object