org.jminor.common

Class States

java.lang.Object

org.jminor.common.States

public final class States
extends java.lang.Object

A factory class for State objects.

See Also:

State

Method Summary

Modifier and Type	Method and Description
static State.AggregateState	aggregateState(Conjunction conjunction, StateObserver... stateObservers) Instantiates a new State.AggregateState object.
static State.Group	group(State... states) Instantiates a new State.Group object, which guarantees that only a single state within the group is active at a time
static State	state() Instantiates a new 'false' State object.
static State	state(boolean value) Instantiates a new State object.

Methods inherited from class java.lang.Object

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

Method Detail

state

public static State state()

Instantiates a new 'false' State object.

Returns:

a new State

state

public static State state(boolean value)

Instantiates a new State object.

Parameters:

value - the initial state value

Returns:

a new State

aggregateState

public static State.AggregateState aggregateState(Conjunction conjunction,
                                                  StateObserver... stateObservers)

Instantiates a new State.AggregateState object.

Parameters:

conjunction - the conjunction to use

stateObservers - the state observers to base this aggregate state on

Returns:

a new State.AggregateState

group

public static State.Group group(State... states)

Instantiates a new State.Group object, which guarantees that only a single state within the group is active at a time

Parameters:

states - the states to add to the group initially, not required

Returns:

a new State.Group

See Also:

State.Group