net.happybrackets.core.config

Class LoadableConfig

java.lang.Object

net.happybrackets.core.config.LoadableConfig

All Implemented Interfaces:

EnvironmentConfig

Direct Known Subclasses:

DeviceConfig, DeviceWifiConfig

public abstract class LoadableConfig
extends java.lang.Object
implements EnvironmentConfig

Provides a loadable abstract class of our core configuration parameters. This class wraps the default methods of the core interface with overridable values. Each time a getInstance call is executed it first checks the the relevant class value. If the value is undefined it delegates to the interface default else it returns the stored value. To instantiate an object extending this class call the static buildFromJSON method. This class holds the static method load which provides a generic interface for building descendants of this object from JSON config files via the Gson library.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Integer	aliveInterval
java.lang.String	audioDir
java.lang.Integer	broadcastOSCPort
java.lang.Integer	clockSynchPort
java.lang.Integer	codeToDevicePort
java.lang.Integer	controllerDiscoveryPort
java.lang.Integer	controllerHTTPPort
java.lang.Integer	controlToDevicePort
java.lang.String	encryptionKey
java.lang.String	knownDevicesFile
java.lang.String	multicastAddr
static LoadableConfig	singletonInstance
java.lang.Integer	statusFromDevicePort
java.lang.String	workingDir

Constructor Summary

Constructors

Constructor and Description
LoadableConfig()

Method Summary

Modifier and Type	Method and Description
int	getAliveInterval()
java.lang.String	getAudioDir()
int	getBroadcastPort()
int	getClockSynchPort()
int	getCodeToDevicePort()
int	getControllerDiscoveryPort()
int	getControllerHTTPPort()
int	getControlToDevicePort()
java.lang.String	getEncryptionKey()
static LoadableConfig	getInstance()
java.lang.String	getKnownDevicesFile()
java.lang.String	getMulticastAddr()
int	getStatusFromDevicePort()
java.lang.String	getWorkingDir()
static <T extends LoadableConfig> T	load(java.lang.String fileName, T config)
static <T extends LoadableConfig> T	loadFromString(java.lang.String configJSON, java.lang.Class<T> configClass) Create a configuration object from the specified JSON string.
void	setKnownDevicesFile(java.lang.String path)
void	setWorkingDir(java.lang.String dir)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.happybrackets.core.config.EnvironmentConfig

getConfigDir

Field Detail

multicastAddr

public java.lang.String multicastAddr

broadcastOSCPort

public java.lang.Integer broadcastOSCPort

statusFromDevicePort

public java.lang.Integer statusFromDevicePort

clockSynchPort

public java.lang.Integer clockSynchPort

codeToDevicePort

public java.lang.Integer codeToDevicePort

controlToDevicePort

public java.lang.Integer controlToDevicePort

controllerDiscoveryPort

public java.lang.Integer controllerDiscoveryPort

controllerHTTPPort

public java.lang.Integer controllerHTTPPort

aliveInterval

public java.lang.Integer aliveInterval

encryptionKey

public java.lang.String encryptionKey

singletonInstance

public static LoadableConfig singletonInstance

workingDir

public java.lang.String workingDir

audioDir

public java.lang.String audioDir

knownDevicesFile

public java.lang.String knownDevicesFile

Constructor Detail

LoadableConfig

public LoadableConfig()

Method Detail

load

public static <T extends LoadableConfig> T load(java.lang.String fileName,
                                                T config)

loadFromString

public static <T extends LoadableConfig> T loadFromString(java.lang.String configJSON,
                                                          java.lang.Class<T> configClass)

Create a configuration object from the specified JSON string. singletonInstance is updated to the new configuration (if a parse error did not occur).

Type Parameters:

T - Configuration object type.

Parameters:

configJSON - The configuration in JSON format.

configClass - The configuration object class to create.

Returns:

Newly created configuration object of class T.

Throws:

com.google.gson.JsonSyntaxException - If the given string is not valid JSON.

getInstance

public static LoadableConfig getInstance()

getMulticastAddr

public java.lang.String getMulticastAddr()

Specified by:

getMulticastAddr in interface EnvironmentConfig

getBroadcastPort

public int getBroadcastPort()

Specified by:

getBroadcastPort in interface EnvironmentConfig

getStatusFromDevicePort

public int getStatusFromDevicePort()

Specified by:

getStatusFromDevicePort in interface EnvironmentConfig

getClockSynchPort

public int getClockSynchPort()

Specified by:

getClockSynchPort in interface EnvironmentConfig

getCodeToDevicePort

public int getCodeToDevicePort()

Specified by:

getCodeToDevicePort in interface EnvironmentConfig

getControlToDevicePort

public int getControlToDevicePort()

Specified by:

getControlToDevicePort in interface EnvironmentConfig

getControllerDiscoveryPort

public int getControllerDiscoveryPort()

Specified by:

getControllerDiscoveryPort in interface EnvironmentConfig

getAliveInterval

public int getAliveInterval()

Specified by:

getAliveInterval in interface EnvironmentConfig

getAudioDir

public java.lang.String getAudioDir()

Specified by:

getAudioDir in interface EnvironmentConfig

setKnownDevicesFile

public void setKnownDevicesFile(java.lang.String path)

getKnownDevicesFile

public java.lang.String getKnownDevicesFile()

Specified by:

getKnownDevicesFile in interface EnvironmentConfig

getControllerHTTPPort

public int getControllerHTTPPort()

Specified by:

getControllerHTTPPort in interface EnvironmentConfig

setWorkingDir

public void setWorkingDir(java.lang.String dir)

getWorkingDir

public java.lang.String getWorkingDir()

Specified by:

getWorkingDir in interface EnvironmentConfig

getEncryptionKey

public java.lang.String getEncryptionKey()

Specified by:

getEncryptionKey in interface EnvironmentConfig