com.gluonhq.particle.state

Class StateManager

java.lang.Object

com.gluonhq.particle.state.StateManager

public class StateManager
extends java.lang.Object

The FormManager is responsible for reading in, and writing out, application state information in an implementation-agnostic fashion.

See Also:

StateIO

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<StateManager.PersistenceMode>	persistenceMode
javafx.beans.property.ObjectProperty<StateIO>	stateIO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateManager.PersistenceMode The StateManager may operate in one of two persistence modes.

Constructor Summary

Constructors

Constructor and Description
StateManager() Creates a new StateManager instance - this should not be called by users, and instead should be left to Particle to manage.

Method Summary

Modifier and Type	Method and Description
void	dispose() This method is called on application shutdown so that the system state can be flushed and disposed appropriately.
StateManager.PersistenceMode	getPersistenceMode() Gets the value of the property persistenceMode.
java.util.Optional<java.lang.Object>	getProperty(java.lang.Object key) Returns an Optional that may contain a value represented by the given key.
java.util.Optional<java.lang.Boolean>	getPropertyAsBoolean(java.lang.Object key) Returns an Optional<Boolean> that may contain a value represented by the given key.
java.util.Optional<java.lang.Double>	getPropertyAsDouble(java.lang.Object key) Returns an Optional<Double> that may contain a value represented by the given key.
java.util.Optional<java.lang.Integer>	getPropertyAsInteger(java.lang.Object key) Returns an Optional<Integer> that may contain a value represented by the given key.
java.util.Optional<java.lang.String>	getPropertyAsString(java.lang.Object key) Returns an Optional<String> that may contain a value represented by the given key.
StateIO	getStateIO() Gets the value of the property stateIO.
void	init() This method is called on application startup so that the system state can be correctly initialised.
javafx.beans.property.ObjectProperty<StateManager.PersistenceMode>	persistenceModeProperty()
void	setPersistenceMode(StateManager.PersistenceMode value) Sets the value of the property persistenceMode.
void	setProperty(java.lang.Object key, java.lang.Object value) Sets the given property under the given key.
void	setStateIO(StateIO value) Sets the value of the property stateIO.
javafx.beans.property.ObjectProperty<StateIO>	stateIOProperty()

Methods inherited from class java.lang.Object

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

Property Detail

stateIO

public final javafx.beans.property.ObjectProperty<StateIO> stateIOProperty

See Also:

getStateIO(), setStateIO(StateIO)

persistenceMode

public final javafx.beans.property.ObjectProperty<StateManager.PersistenceMode> persistenceModeProperty

See Also:

getPersistenceMode(), setPersistenceMode(PersistenceMode)

Constructor Detail

StateManager

public StateManager()

Creates a new StateManager instance - this should not be called by users, and instead should be left to Particle to manage.

Method Detail

getStateIO

public final StateIO getStateIO()

Gets the value of the property stateIO.

setStateIO

public final void setStateIO(StateIO value)

Sets the value of the property stateIO.

stateIOProperty

public final javafx.beans.property.ObjectProperty<StateIO> stateIOProperty()

See Also:

getStateIO(), setStateIO(StateIO)

getPersistenceMode

public final StateManager.PersistenceMode getPersistenceMode()

Gets the value of the property persistenceMode.

setPersistenceMode

public final void setPersistenceMode(StateManager.PersistenceMode value)

Sets the value of the property persistenceMode.

persistenceModeProperty

public final javafx.beans.property.ObjectProperty<StateManager.PersistenceMode> persistenceModeProperty()

See Also:

getPersistenceMode(), setPersistenceMode(PersistenceMode)

init

public void init()

This method is called on application startup so that the system state can be correctly initialised. It should not be called by users, and instead left to Particle to manage.

dispose

public void dispose()

This method is called on application shutdown so that the system state can be flushed and disposed appropriately. It should not be called by users, and instead left to Particle to manage.

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object value)

Sets the given property under the given key.

getProperty

public java.util.Optional<java.lang.Object> getProperty(java.lang.Object key)

Returns an Optional that may contain a value represented by the given key.

getPropertyAsString

public java.util.Optional<java.lang.String> getPropertyAsString(java.lang.Object key)

Returns an Optional<String> that may contain a value represented by the given key.

getPropertyAsDouble

public java.util.Optional<java.lang.Double> getPropertyAsDouble(java.lang.Object key)

Returns an Optional<Double> that may contain a value represented by the given key.

getPropertyAsInteger

public java.util.Optional<java.lang.Integer> getPropertyAsInteger(java.lang.Object key)

Returns an Optional<Integer> that may contain a value represented by the given key.

getPropertyAsBoolean

public java.util.Optional<java.lang.Boolean> getPropertyAsBoolean(java.lang.Object key)

Returns an Optional<Boolean> that may contain a value represented by the given key.