Module org.refcodes.runtime

Package org.refcodes.runtime

Class Configuration

java.lang.Object

org.refcodes.runtime.Configuration

All Implemented Interfaces:

org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,Configuration>, org.refcodes.mixin.KeyAccessor.KeyMutator<String>, org.refcodes.mixin.KeyAccessor.KeyProperty<String>

public class Configuration
extends Object
implements org.refcodes.mixin.KeyAccessor.KeyProperty<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,Configuration>

Converts a key to the format of a system property (camel-case) or an environment variable (snake-case in upper-case).

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.KeyAccessor

org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K>, org.refcodes.mixin.KeyAccessor.KeyProperty<K>

Constructor Summary

Constructors

Constructor	Description
Configuration()

Method Summary

Modifier and Type	Method	Description
protected static String	asNormalized(String aText, char aSeparator)	Normalizes the provided text.
String	getEnvironmentVariable(String aKey)	Returns the according environment variable after having converted the provided key to an environment variable.
String	getKey()
String	getSystemProperty(String aKey)	Returns the according system's property after having converted the provided key to a system property.
void	setKey(String aKey)
String	toEnvironmentVariable()	Converts the key as of getKey() to an environment variable.
String	toEnvironmentVariable(String aKey)	Converts the provided key to an environment variable.
String	toPath()	Converts the key as of getKey() to a path (as of PathMap).
String	toPath(String aKey)	Converts the provided key as of getKey() to a path (as of PathMap).
String	toSystemProperty()	Converts the key as of getKey() to a system property.
String	toSystemProperty(String aKey)	Converts the provided key to a system property.
Configuration	withKey(String aKey)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.KeyAccessor.KeyProperty

letKey

Constructor Details

Configuration

public Configuration()

Method Details

getKey

public String getKey()

Specified by:

getKey in interface org.refcodes.mixin.KeyAccessor<String>

setKey

public void setKey(String aKey)

Specified by:

setKey in interface org.refcodes.mixin.KeyAccessor.KeyMutator<String>

withKey

public Configuration withKey(String aKey)

Specified by:

withKey in interface org.refcodes.mixin.KeyAccessor.KeyBuilder<String,Configuration>

toPath

public String toPath()

Converts the key as of getKey() to a path (as of PathMap). A path begins with a path delimiter "/" (as of Delimiter.PATH and with all non alphanumeric digits being replaced by the path delimiter. Any non alphanumeric sequence is truncated to a single path delimiter.

Returns:

The path representation of the according key.

toPath

public String toPath(String aKey)

Converts the provided key as of getKey() to a path (as of PathMap). A path begins with a path delimiter "/" (as of Delimiter.PATH and with all non alphanumeric digits being replaced by the path delimiter. Any non alphanumeric sequence is truncated to a single path delimiter.

Parameters:

aKey - The key to be converted.

Returns:

The path representation of the according key.

toSystemProperty

public String toSystemProperty()

Converts the key as of getKey() to a system property. A system property is the camel-case version of the according key.

Returns:

The camel-case representation of the according key.

toEnvironmentVariable

public String toEnvironmentVariable()

Converts the key as of getKey() to an environment variable. An environment variable is the upper-case snake-case version of the according key.

Returns:

The upper-case snake-case representation of the according key.

toSystemProperty

public String toSystemProperty(String aKey)

Converts the provided key to a system property. A system property is the camel-case version of the according key.

Parameters:

aKey - The key to be converted.

Returns:

The camel-case representation of the according key.

toEnvironmentVariable

public String toEnvironmentVariable(String aKey)

Converts the provided key to an environment variable. An environment variable is the upper-case snake-case version of the according key.

Parameters:

aKey - The key to be converted.

Returns:

The upper-case snake-case representation of the according key.

getSystemProperty

public String getSystemProperty(String aKey)

Returns the according system's property after having converted the provided key to a system property. A system property is the camel-case version of the according key.

Parameters:

aKey - The value of the key to be converted.

Returns:

The system's property of the camel-case representation of the according key.

getEnvironmentVariable

public String getEnvironmentVariable(String aKey)

Returns the according environment variable after having converted the provided key to an environment variable. An environment variable is the upper-case snake-case version of the according key.

Parameters:

aKey - The value of the key to be converted.

Returns:

The environment variable of the upper-case snake-case representation of the according key.

asNormalized

protected static String asNormalized(String aText,
 char aSeparator)

Normalizes the provided text.

Parameters:

aText - The text to be normalized.

aSeparator - The character to be used for normalization.

Returns:

The normalized String (can be null).