org.macroing.cit.configuration.property

Class ObjectProperty

java.lang.Object

org.macroing.cit.configuration.property.ObjectProperty

All Implemented Interfaces:

ConfigurationObserver

public final class ObjectProperty
extends java.lang.Object
implements ConfigurationObserver

An ObjectProperty is a ConfigurationObserver implementation that observes changes to a configuration value with a given ID and is of type Object.

You can think of this class as a variable of type Object. This means you can get or set its value. Setting its value will set it in its current Configuration, if present.

This class is thread-safe and therefore also suitable for concurrent use without external synchronization.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
ObjectProperty(java.lang.String id) Constructs a new ObjectProperty given an ID.
ObjectProperty(java.lang.String id, java.lang.Object defaultValue) Constructs a new ObjectProperty given an ID and a default configuration value.
ObjectProperty(java.lang.String id, java.lang.Object defaultValue, java.util.function.Consumer<java.lang.Object> consumer) Constructs a new ObjectProperty given an ID, a default configuration value and an Consumer to consume the configuration value.

Method Summary

Modifier and Type	Method and Description
void	added(Configuration configuration) Called by the Configuration that this ConfigurationObserver instance was just added to.
java.lang.Object	get() Returns the current configuration value.
void	objectSet(Configuration configuration, java.lang.String id, java.util.Optional<?> oldObject, java.util.Optional<?> newObject) Called by a Configuration when a new Object has been set for a given ID.
void	removed(Configuration configuration) Called by the Configuration that this ConfigurationObserver instance was just removed from.
void	set(java.lang.Object value) Sets a new configuration value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectProperty

public ObjectProperty(java.lang.String id)

Constructs a new ObjectProperty given an ID.

Calling this constructor is equivalent to calling new ObjectProperty(id, null).

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value to observe changes to

Throws:

java.lang.NullPointerException - thrown if, and only if, id is null

ObjectProperty

public ObjectProperty(java.lang.String id,
                      java.lang.Object defaultValue)

Constructs a new ObjectProperty given an ID and a default configuration value.

Calling this constructor is equivalent to calling new ObjectProperty(id, defaultValue, value -> {}).

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value to observe changes to

defaultValue - the default configuration value to return in case no configuration value with the given ID exists

Throws:

java.lang.NullPointerException - thrown if, and only if, id is null

ObjectProperty

public ObjectProperty(java.lang.String id,
                      java.lang.Object defaultValue,
                      java.util.function.Consumer<java.lang.Object> consumer)

Constructs a new ObjectProperty given an ID, a default configuration value and an Consumer to consume the configuration value.

If either id or consumer are null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value to observe changes to

defaultValue - the default configuration value to return in case no configuration value with the given ID exists

consumer - the Consumer that will consume the configuration value on changes

Throws:

java.lang.NullPointerException - thrown if, and only if, either id or consumer are null

Method Detail

get

public java.lang.Object get()

Returns the current configuration value.

If no configuration value was ever stored in the Configuration, the default configuration value will be returned.

Returns:

the current configuration value

added

public void added(Configuration configuration)

Called by the Configuration that this ConfigurationObserver instance was just added to.

If configuration is null, a NullPointerException will be thrown.

Specified by:

added in interface ConfigurationObserver

Parameters:

configuration - the Configuration that called this method

Throws:

java.lang.NullPointerException - thrown if, and only if, configuration is null

objectSet

public void objectSet(Configuration configuration,
                      java.lang.String id,
                      java.util.Optional<?> oldObject,
                      java.util.Optional<?> newObject)

Called by a Configuration when a new Object has been set for a given ID.

If either configuration, id, oldObject or newObject are null, a NullPointerException will be thrown.

Specified by:

objectSet in interface ConfigurationObserver

Parameters:

configuration - the Configuration that called this method

id - the ID of the Object

oldObject - an Optional that contains the old configuration value, if it was set

newObject - an Optional that contains the new configuration value, if it is set

Throws:

java.lang.NullPointerException - thrown if, and only if, either configuration, id, oldObject or newObject are null

removed

public void removed(Configuration configuration)

Called by the Configuration that this ConfigurationObserver instance was just removed from.

If configuration is null, a NullPointerException will be thrown.

Specified by:

removed in interface ConfigurationObserver

Parameters:

configuration - the Configuration that called this method

Throws:

java.lang.NullPointerException - thrown if, and only if, configuration is null

set

public void set(java.lang.Object value)

Sets a new configuration value.

This method will set the new configuration value in the Configuration, if present. The Configuration will only be present if you have added this ObjectProperty to a Configuration.

Parameters:

value - the new configuration value