net.kuujo.copycat.state

Interface StateContext<T>

public interface StateContext<T>

Copycat state context.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
StateContext<T>	clear() Clears state from the state context.
Cluster	cluster() Returns the current state cluster.
<U> U	get(String key) Gets a value from the state context.
StateContext<T>	put(String key, Object value) Puts a value in the state context.
<U> U	remove(String key) Removes a value from the state context.
T	state() Returns the current state.
StateContext<T>	transition(T state) Transitions the context to a new state.

Method Detail

cluster

Cluster cluster()

Returns the current state cluster.

Returns:

The current state cluster.

state

T state()

Returns the current state.

Returns:

The current state.

put

StateContext<T> put(String key,
                    Object value)

Puts a value in the state context.

Parameters:

key - The state key.

value - The state value.

Returns:

The state context.

get

<U> U get(String key)

Gets a value from the state context.

Type Parameters:

U - The state value type.

Parameters:

key - The state key.

Returns:

The state value.

remove

<U> U remove(String key)

Removes a value from the state context.

Type Parameters:

U - The state value type.

Parameters:

key - The state key.

Returns:

The removed state value.

clear

StateContext<T> clear()

Clears state from the state context.

Returns:

The state context.

transition

StateContext<T> transition(T state)

Transitions the context to a new state.

Parameters:

state - The state to which to transition.

Returns:

The state context.