Module is.codion.common.core

Package is.codion.common.state

Interface State

All Superinterfaces:

Observable<Boolean>, ObservableState, Observer<Boolean>, Value<Boolean>

public interface State
extends ObservableState, Value<Boolean>

A class encapsulating a boolean state, non-nullable with null values translated to false.

State state = State.state();

ObservableState observable = state.observable();

observer.addConsumer(this::onStateChange);

state.set(true);
state.set(false);
state.set(null); //translates to false

A factory for State instances.

See Also:

• state()
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	State.Builder	Builds a State instance.
static interface	State.Combination	A state which combines a number of states, either ANDing or ORing those together when determining its own state.
static interface	State.Group	A State.Group deactivates all other states when a state in the group is activated.

Nested classes/interfaces inherited from interface is.codion.common.value.Value

Value.BuilderFactory, Value.Notify, Value.Validator<T>

Method Summary

Modifier and Type	Method	Description
static State.Combination	and(ObservableState... observableStates)	Creates a new State.Combination instance using Conjunction.AND.
static State.Combination	and(Collection<? extends ObservableState> observableStates)	Creates a new State.Combination instance using Conjunction.AND.
static State.Builder	builder()
static State.Builder	builder(boolean value)
static State.Combination	combination(Conjunction conjunction, ObservableState... observableStates)	Creates a new State.Combination instance.
static State.Combination	combination(Conjunction conjunction, Collection<? extends ObservableState> observableStates)	Creates a new State.Combination instance.
@NonNull Boolean	get()
static State.Group	group(State... states)	Creates a new State.Group instance, which guarantees that only a single state within the group is active at a time
static State.Group	group(Collection<State> states)	Creates a new State.Group instance, which guarantees that only a single state within the group is active at a time
ObservableState	observable()	Returns an ObservableState notified each time the state changes
static State.Combination	or(ObservableState... observableStates)	Creates a new State.Combination instance using Conjunction.OR.
static State.Combination	or(Collection<? extends ObservableState> observableStates)	Creates a new State.Combination instance using Conjunction.OR.
static State	state()	Creates a new 'false' State instance.
static State	state(boolean value)	Creates a new State instance.

Methods inherited from interface is.codion.common.observable.Observable

addConsumer, addListener, addWeakConsumer, addWeakListener, getOrThrow, getOrThrow, isEqualTo, isNotEqualTo, observer, optional, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener

Methods inherited from interface is.codion.common.state.ObservableState

isNull, isNullable, not

Methods inherited from interface is.codion.common.value.Value

addValidator, clear, link, link, map, removeValidator, set, unlink, unlink, validate

Method Details

get

@NonNull Boolean get()

Specified by:

get in interface Observable<Boolean>

Specified by:

get in interface ObservableState

Returns:

the value

observable

ObservableState observable()

Returns an ObservableState notified each time the state changes

Specified by:

observable in interface Value<Boolean>

Returns:

an ObservableState notified each time the state changes

state

static State state()

Creates a new 'false' State instance.

Returns:

a new State instance

state

static State state(boolean value)

Creates a new State instance.

Parameters:

value - the initial state value

Returns:

a new State instance

builder

static State.Builder builder()

Returns:

a new State.Builder instance

builder

static State.Builder builder(boolean value)

Parameters:

value - the initial value

Returns:

a new State.Builder instance

combination

static State.Combination combination(Conjunction conjunction,
 ObservableState... observableStates)

Creates a new State.Combination instance.

Parameters:

conjunction - the conjunction to use

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

combination

static State.Combination combination(Conjunction conjunction,
 Collection<? extends ObservableState> observableStates)

Creates a new State.Combination instance.

Parameters:

conjunction - the conjunction to use

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

and

static State.Combination and(ObservableState... observableStates)

Creates a new State.Combination instance using Conjunction.AND.

Parameters:

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

and

static State.Combination and(Collection<? extends ObservableState> observableStates)

Creates a new State.Combination instance using Conjunction.AND.

Parameters:

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

or

static State.Combination or(ObservableState... observableStates)

Creates a new State.Combination instance using Conjunction.OR.

Parameters:

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

or

static State.Combination or(Collection<? extends ObservableState> observableStates)

Creates a new State.Combination instance using Conjunction.OR.

Parameters:

observableStates - the state observers to base this state combination on

Returns:

a new State.Combination instance

group

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

Creates a new State.Group instance, 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 instance

See Also:

• State.Group

group

static State.Group group(Collection<State> states)

Creates a new State.Group instance, 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

Returns:

a new State.Group instance

See Also:

• State.Group