org.macroing.cit.configuration

Class Configuration

java.lang.Object

org.macroing.cit.configuration.Configuration

public final class Configuration
extends java.lang.Object

A class to set and get configuration values.

To set or unset a configuration value, you call the setObject(String, Object) method. If the second argument is null, unsetting is performed, whereas any other value sets the configuration value.

Getting a configuration value, whether previously set or not, can be performed by calling getBoolean(String), getObject(String, Class, Object), getInt(String, int) or a wide range of other methods. What they all have in common is that they all return an instance of an OptionalBoolean, an Optional, an OptionalInt or some other optional wrapper class.

If a configuration value is set using one type, it is possible that getting it using another type may work. So for instance, lets say you call setObject("A", Byte.valueOf((byte)(100))) followed by the call getInt("A"), then you will get an OptionalInt with the value 100 set. This is possible because some decoding is performed behind the scenes. Decoding isn't only performed on integer types.

The following list demonstrates the decoding that is possible so far given the String representation of an Object (using its toString() method):

• A Boolean is decoded after the following check Objects2.equalsIgnoreCase(toString, "0", "1", "false", "true").
• A Byte is decoded as Byte.decode(toString).
• A Character is decoded as Character.valueOf(toString.charAt(0)).
• A Double is decoded as Double.valueOf(toString.replace(',', '.')).
• A Float is decoded as Float.valueOf(toString.replace(',', '.')).
• An Integer is decoded as Integer.decode(toString).
• A Long is decoded as Long.decode(toString).
• A Short is decoded as Short.decode(toString).

The following code snippet demonstrates how you can use this API:

 
 Configuration configuration = new Configuration();
 configuration.addConfigurationObserver((configuration0, id, oldObject, newObject) -> System.out.println(newObject));
 configuration.setObject("A", true);
 
 OptionalBoolean a = configuration.getBoolean("A");
 OptionalBoolean b = configuration.getBoolean("B", false);
 
 

This class is thread-safe and therefore also suitable for concurrent use without external synchronization. Although, this may not be true for all Objects stored as configuration values.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
Configuration() Constructs a new empty Configuration instance.

Method Summary

Modifier and Type	Method and Description
boolean	addConfigurationObserver(ConfigurationObserver configurationObserver) Adds configurationObserver, if absent.
Configuration	clear() Clears all configuration values currently held by this Configuration instance.
org.macroing.cit.java.util.OptionalBoolean	getBoolean(java.lang.String id) Returns an OptionalBoolean that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalBoolean	getBoolean(java.lang.String id, boolean defaultValue) Returns an OptionalBoolean that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalByte	getByte(java.lang.String id) Returns an OptionalByte that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalByte	getByte(java.lang.String id, byte defaultValue) Returns an OptionalByte that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalChar	getChar(java.lang.String id) Returns an OptionalChar that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalChar	getChar(java.lang.String id, char defaultValue) Returns an OptionalChar that may or may not contain a configuration value.
java.util.OptionalDouble	getDouble(java.lang.String id) Returns an OptionalDouble that may or may not contain a configuration value.
java.util.OptionalDouble	getDouble(java.lang.String id, double defaultValue) Returns an OptionalDouble that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalFloat	getFloat(java.lang.String id) Returns an OptionalFloat that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalFloat	getFloat(java.lang.String id, float defaultValue) Returns an OptionalFloat that may or may not contain a configuration value.
java.util.OptionalInt	getInt(java.lang.String id) Returns an OptionalInt that may or may not contain a configuration value.
java.util.OptionalInt	getInt(java.lang.String id, int defaultValue) Returns an OptionalInt that may or may not contain a configuration value.
java.util.OptionalLong	getLong(java.lang.String id) Returns an OptionalLong that may or may not contain a configuration value.
java.util.OptionalLong	getLong(java.lang.String id, long defaultValue) Returns an OptionalLong that may or may not contain a configuration value.
<T> java.util.Optional<T>	getObject(java.lang.String id, java.lang.Class<T> clazz) Returns an Optional that may or may not contain a configuration value.
<T> java.util.Optional<T>	getObject(java.lang.String id, java.lang.Class<T> clazz, T defaultValue) Returns an Optional that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalShort	getShort(java.lang.String id) Returns an OptionalShort that may or may not contain a configuration value.
org.macroing.cit.java.util.OptionalShort	getShort(java.lang.String id, short defaultValue) Returns an OptionalShort that may or may not contain a configuration value.
boolean	removeConfigurationObserver(ConfigurationObserver configurationObserver) Removes configurationObserver, if present.
Configuration	setObject(java.lang.String id, java.lang.Object object) Sets or unsets a configuration value in this Configuration instance.
int	size() Returns the size of this Configuration instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Constructs a new empty Configuration instance.

Method Detail

addConfigurationObserver

public boolean addConfigurationObserver(ConfigurationObserver configurationObserver)

Adds configurationObserver, if absent.

Returns true if, and only if, configurationObserver was added, false otherwise.

If configurationObserver is null, a NullPointerException will be thrown.

Parameters:

configurationObserver - the ConfigurationObserver to add

Returns:

true if, and only if, configurationObserver was added, false otherwise

Throws:

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

removeConfigurationObserver

public boolean removeConfigurationObserver(ConfigurationObserver configurationObserver)

Removes configurationObserver, if present.

Returns true if, and only if, configurationObserver was removed, false otherwise.

If configurationObserver is null, a NullPointerException will be thrown.

Parameters:

configurationObserver - the ConfigurationObserver to remove

Returns:

true if, and only if, configurationObserver was removed, false otherwise

Throws:

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

clear

public Configuration clear()

Clears all configuration values currently held by this Configuration instance.

Returns itself, such that method chaining is possible.

When a configuration value has been cleared (or unset), all currently added ConfigurationObservers will be notified.

Returns:

itself, such that method chaining is possible

setObject

public Configuration setObject(java.lang.String id,
                               java.lang.Object object)

Sets or unsets a configuration value in this Configuration instance.

Returns itself, such that method chaining is possible.

If id is null, a NullPointerException will be thrown.

To unset a configuration value, simply provide null as the second argument (in place of object).

When a configuration value has been set or unset, all currently added ConfigurationObservers will be notified. This is performed even if no noticeable change is made.

Parameters:

id - the ID of the configuration value

object - the configuration value itself, or null to unset it

Returns:

itself, such that method chaining is possible

size

public int size()

Returns the size of this Configuration instance.

Returns:

the size of this Configuration instance

getObject

public <T> java.util.Optional<T> getObject(java.lang.String id,
                                           java.lang.Class<T> clazz)

Returns an Optional that may or may not contain a configuration value.

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

Type Parameters:

T - the type of the configuration value

Parameters:

id - the ID of the configuration value

clazz - the Class corresponding to the type of the configuration value

Returns:

an Optional that may or may not contain a configuration value

Throws:

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

getObject

public <T> java.util.Optional<T> getObject(java.lang.String id,
                                           java.lang.Class<T> clazz,
                                           T defaultValue)

Returns an Optional that may or may not contain a configuration value.

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

Type Parameters:

T - the type of the configuration value

Parameters:

id - the ID of the configuration value

clazz - the Class corresponding to the type of the configuration value

defaultValue - the default configuration value, which may be null, and will be used if no such configuration value can be found

Returns:

an Optional that may or may not contain a configuration value

Throws:

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

getBoolean

public org.macroing.cit.java.util.OptionalBoolean getBoolean(java.lang.String id)

Returns an OptionalBoolean that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalBoolean that may or may not contain a configuration value

Throws:

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

getBoolean

public org.macroing.cit.java.util.OptionalBoolean getBoolean(java.lang.String id,
                                                             boolean defaultValue)

Returns an OptionalBoolean that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalBoolean that may or may not contain a configuration value

Throws:

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

getByte

public org.macroing.cit.java.util.OptionalByte getByte(java.lang.String id)

Returns an OptionalByte that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalByte that may or may not contain a configuration value

Throws:

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

getByte

public org.macroing.cit.java.util.OptionalByte getByte(java.lang.String id,
                                                       byte defaultValue)

Returns an OptionalByte that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalByte that may or may not contain a configuration value

Throws:

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

getChar

public org.macroing.cit.java.util.OptionalChar getChar(java.lang.String id)

Returns an OptionalChar that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalChar that may or may not contain a configuration value

Throws:

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

getChar

public org.macroing.cit.java.util.OptionalChar getChar(java.lang.String id,
                                                       char defaultValue)

Returns an OptionalChar that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalChar that may or may not contain a configuration value

Throws:

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

getDouble

public java.util.OptionalDouble getDouble(java.lang.String id)

Returns an OptionalDouble that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalDouble that may or may not contain a configuration value

Throws:

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

getDouble

public java.util.OptionalDouble getDouble(java.lang.String id,
                                          double defaultValue)

Returns an OptionalDouble that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalDouble that may or may not contain a configuration value

Throws:

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

getFloat

public org.macroing.cit.java.util.OptionalFloat getFloat(java.lang.String id)

Returns an OptionalFloat that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalFloat that may or may not contain a configuration value

Throws:

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

getFloat

public org.macroing.cit.java.util.OptionalFloat getFloat(java.lang.String id,
                                                         float defaultValue)

Returns an OptionalFloat that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalFloat that may or may not contain a configuration value

Throws:

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

getInt

public java.util.OptionalInt getInt(java.lang.String id)

Returns an OptionalInt that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalInt that may or may not contain a configuration value

Throws:

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

getInt

public java.util.OptionalInt getInt(java.lang.String id,
                                    int defaultValue)

Returns an OptionalInt that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalInt that may or may not contain a configuration value

Throws:

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

getLong

public java.util.OptionalLong getLong(java.lang.String id)

Returns an OptionalLong that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalLong that may or may not contain a configuration value

Throws:

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

getLong

public java.util.OptionalLong getLong(java.lang.String id,
                                      long defaultValue)

Returns an OptionalLong that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalLong that may or may not contain a configuration value

Throws:

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

getShort

public org.macroing.cit.java.util.OptionalShort getShort(java.lang.String id)

Returns an OptionalShort that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

Returns:

an OptionalShort that may or may not contain a configuration value

Throws:

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

getShort

public org.macroing.cit.java.util.OptionalShort getShort(java.lang.String id,
                                                         short defaultValue)

Returns an OptionalShort that may or may not contain a configuration value.

If id is null, a NullPointerException will be thrown.

Parameters:

id - the ID of the configuration value

defaultValue - the default configuration value, that will be used if no such configuration value can be found

Returns:

an OptionalShort that may or may not contain a configuration value

Throws:

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