org.refcodes.runtime.impls

Class RuntimePropertiesImpl

java.lang.Object

org.refcodes.runtime.impls.RuntimePropertiesImpl

All Implemented Interfaces:

org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.TypeAccessor<String>, RuntimeProperties, org.refcodes.structure.CanonicalMap, org.refcodes.structure.Containable, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.ProfileProperties, org.refcodes.structure.Properties, org.refcodes.structure.PropertiesAccessorMixin

public class RuntimePropertiesImpl
extends Object
implements RuntimeProperties

Implementation of the immutable RuntimeProperties interface. The RuntimePropertiesImpl load the first properties file found (with "key=value" entries) in one of several default locations determined by the RuntimeUtility.toAppConfigDirs() method. At the time of this writing (2015-11-12), the locations which to seek for the first occurrence of the properties file are determined as follows: The applications base directory (where your JAR or your classes reside) is taken and a list of directories relative to this base directory is generated as defined in the Folders.CONFIG_DIRS enumeration: The actual directories being returned (in case them exist) are as follows, relative to your applications base directory:

• ../config"
• ../etc"
• ../settings"
• ../.config"
• ../settings"
• ."
• ./config"
• ./etc"
• ./settings"
• ./.config"
• ./settings"

In case you pass a JVM argument via "-Dconfig.dir=path_to_your_config_dir" (where path_to_your_config_dir stands for the path to the directory where you placed configuration files), then your path_to_your_config_dir is placed first in the list (in case the directory exists).Also see SystemProperty.CONFIG_DIR. Any property overridden by an equivalent system property or an equivalent environment variable is, when requested, replaced by the overridden one; in that order: If there is an equivalent system property, then this one is retrieved, else if there is an equivalent environment variable, then that is used, else the one stored in this Properties instance is taken. See PropertyBuilder on how equivalent system properties and equivalent environment variables are determined. The above mentioned mechanism is applied to all related methods (e.g. PropertiesAccessorMixin.getBoolean(String) or PropertiesAccessorMixin.getLong(String)).

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.runtime.RuntimeProperties

RuntimeProperties.MutableRuntimeProperties, RuntimeProperties.RuntimePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.ProfileProperties

org.refcodes.structure.ProfileProperties.MutableProfileProperties, org.refcodes.structure.ProfileProperties.ProfilePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.Properties

org.refcodes.structure.Properties.MutableProperties, org.refcodes.structure.Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

org.refcodes.structure.PathMap.MutablePathMap<T>, org.refcodes.structure.PathMap.PathMapBuilder<T>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

org.refcodes.structure.Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.structure.Keys

org.refcodes.structure.Keys.MutableKeys<K,V>, org.refcodes.structure.Keys.MutableValues<K,V>

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

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

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

org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Field Summary

Fields

Modifier and Type	Field and Description
protected RuntimeProperties.RuntimePropertiesBuilder	_properties

Fields inherited from interface org.refcodes.structure.ProfileProperties

RUNTIME_PROFILES_PATH

Fields inherited from interface org.refcodes.structure.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor and Description
RuntimePropertiesImpl(File aFile) Instantiates a new runtime properties impl.
RuntimePropertiesImpl(Map<?,?> aProperties) Instantiates a new runtime properties impl.
RuntimePropertiesImpl(org.refcodes.structure.ProfileProperties aProperties) Instantiates a new runtime properties impl.
RuntimePropertiesImpl(org.refcodes.structure.Properties aProperties) Instantiates a new runtime properties impl.
RuntimePropertiesImpl(String aFilePath) Instantiates a new runtime properties impl.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object aKey)
String	get(Object aKey)
char	getDelimiter()
String	getRuntimeProfilesPath()
Class<String>	getType()
boolean	isEmpty()
Set<String>	keySet()
RuntimeProperties	retrieveFrom(String aFromPath) Retrieve from.
RuntimeProperties	retrieveTo(String aToPath) Retrieve to.
int	size()
Object	toDataStructure(String aPath)
Collection<String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.runtime.RuntimeProperties

retrieve, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties

Methods inherited from interface org.refcodes.structure.ProfileProperties

getRuntimeProfiles, toProfileProperties, toProfileProperties, toProfileProperties, toProfileProperties, toProfileProperties, toProfileProperties, toProfileProperties, toRuntimeProfile, toRuntimeProfile

Methods inherited from interface org.refcodes.structure.Properties

containsValue, fromProperties, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, toMap, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.structure.CanonicalMap

toType, toType

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, getArray, getArray, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toRootPath

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

get, getBoolean, getBoolean, getByte, getByte, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort

Field Detail

_properties

protected RuntimeProperties.RuntimePropertiesBuilder _properties

Constructor Detail

RuntimePropertiesImpl

public RuntimePropertiesImpl(File aFile)
                      throws IOException

Instantiates a new runtime properties impl.

Parameters:

aFile - the a file

Throws:

IOException - Signals that an I/O exception has occurred.

RuntimePropertiesImpl

public RuntimePropertiesImpl(String aFilePath)
                      throws IOException

Instantiates a new runtime properties impl.

Parameters:

aFilePath - the a file path

Throws:

IOException - Signals that an I/O exception has occurred.

RuntimePropertiesImpl

public RuntimePropertiesImpl(org.refcodes.structure.Properties aProperties)

Instantiates a new runtime properties impl.

Parameters:

aProperties - the a properties

RuntimePropertiesImpl

public RuntimePropertiesImpl(org.refcodes.structure.ProfileProperties aProperties)

Instantiates a new runtime properties impl.

Parameters:

aProperties - the a properties

RuntimePropertiesImpl

public RuntimePropertiesImpl(Map<?,?> aProperties)

Instantiates a new runtime properties impl.

Parameters:

aProperties - the a properties

Method Detail

containsKey

public boolean containsKey(Object aKey)

Specified by:

containsKey in interface org.refcodes.structure.Keys<String,String>

get

public String get(Object aKey)

Specified by:

get in interface org.refcodes.structure.Keys<String,String>

keySet

public Set<String> keySet()

Specified by:

keySet in interface org.refcodes.structure.Keys<String,String>

values

public Collection<String> values()

Specified by:

values in interface org.refcodes.structure.Keys<String,String>

size

public int size()

Specified by:

size in interface org.refcodes.structure.Containable

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.refcodes.structure.Containable

retrieveFrom

public RuntimeProperties retrieveFrom(String aFromPath)

Description copied from interface: RuntimeProperties

Retrieve from.

Specified by:

retrieveFrom in interface RuntimeProperties

Specified by:

retrieveFrom in interface org.refcodes.structure.PathMap<String>

Specified by:

retrieveFrom in interface org.refcodes.structure.ProfileProperties

Specified by:

retrieveFrom in interface org.refcodes.structure.Properties

Parameters:

aFromPath - the a from path

Returns:

the runtime properties

retrieveTo

public RuntimeProperties retrieveTo(String aToPath)

Description copied from interface: RuntimeProperties

Retrieve to.

Specified by:

retrieveTo in interface RuntimeProperties

Specified by:

retrieveTo in interface org.refcodes.structure.PathMap<String>

Specified by:

retrieveTo in interface org.refcodes.structure.ProfileProperties

Specified by:

retrieveTo in interface org.refcodes.structure.Properties

Parameters:

aToPath - the a to path

Returns:

the runtime properties

getDelimiter

public char getDelimiter()

Specified by:

getDelimiter in interface org.refcodes.mixin.DelimiterAccessor

getType

public Class<String> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor<String>

toDataStructure

public Object toDataStructure(String aPath)

Specified by:

toDataStructure in interface org.refcodes.structure.PathMap<String>

getRuntimeProfilesPath

public String getRuntimeProfilesPath()

Specified by:

getRuntimeProfilesPath in interface org.refcodes.structure.ProfileProperties