org.refcodes.runtime.impls

Class RuntimePropertiesBuilderImpl

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,T>

org.refcodes.structure.impls.PathMapBuilderImpl<String>

org.refcodes.structure.impls.PropertiesBuilderImpl

org.refcodes.structure.impls.ProfilePropertiesBuilderImpl

org.refcodes.runtime.impls.RuntimePropertiesBuilderImpl

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.TypeAccessor<String>, RuntimeProperties, RuntimeProperties.MutableRuntimeProperties, RuntimeProperties.RuntimePropertiesBuilder, org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap, org.refcodes.structure.Clearable, org.refcodes.structure.Containable, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.Keys.MutableKeys<String,String>, org.refcodes.structure.Keys.MutableValues<String,String>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PathMap.MutablePathMap<String>, org.refcodes.structure.PathMap.PathMapBuilder<String>, org.refcodes.structure.ProfileProperties, org.refcodes.structure.ProfileProperties.MutableProfileProperties, org.refcodes.structure.ProfileProperties.ProfilePropertiesBuilder, org.refcodes.structure.Properties, org.refcodes.structure.Properties.MutableProperties, org.refcodes.structure.Properties.PropertiesBuilder, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

public class RuntimePropertiesBuilderImpl
extends org.refcodes.structure.impls.ProfilePropertiesBuilderImpl
implements RuntimeProperties.RuntimePropertiesBuilder

Implementation of the mutable RuntimeProperties.RuntimePropertiesBuilder interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

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.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 File	_propertiesFile

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
RuntimePropertiesBuilderImpl() Instantiates a new runtime properties builder impl.
RuntimePropertiesBuilderImpl(File aPropertiesFile) Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().
RuntimePropertiesBuilderImpl(InputStream aInputStream) Instantiates a new runtime properties builder impl.
RuntimePropertiesBuilderImpl(Map<?,?> aProperties) Instantiates a new runtime properties builder impl.
RuntimePropertiesBuilderImpl(org.refcodes.structure.Properties aProperties) Instantiates a new runtime properties builder impl.
RuntimePropertiesBuilderImpl(String aPropertiesFile) Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().
RuntimePropertiesBuilderImpl(URL aURL) Instantiates a new runtime properties builder impl.

Method Summary

Modifier and Type	Method and Description
void	flush() Writes the properties back to the file from which the properties were loaded, e.g. see Properties.saveTo(File, String) or Properties.saveTo(String).
protected void	fromFile(File aFile) From file.
String	get(Object aKey)
RuntimeProperties.RuntimePropertiesBuilder	retrieveFrom(String aFromPath) Retrieve from.
RuntimeProperties.RuntimePropertiesBuilder	retrieveTo(String aToPath) Retrieve to.

Methods inherited from class org.refcodes.structure.impls.ProfilePropertiesBuilderImpl

getRuntimeProfilesPath

Methods inherited from class org.refcodes.structure.impls.PathMapBuilderImpl

compute, computeIfAbsent, computeIfPresent, containsKey, getDelimiter, getOrDefault, getType, merge, put, putIfAbsent, remove, remove, replace, replace, toDataStructure

Methods inherited from class java.util.HashMap

clear, clone, containsValue, entrySet, forEach, isEmpty, keySet, putAll, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.runtime.RuntimeProperties.RuntimePropertiesBuilder

retrieve, toRuntimePropertiesBuilder, toRuntimePropertiesBuilder, toRuntimePropertiesBuilder, toRuntimePropertiesBuilder, toRuntimePropertiesBuilder, toRuntimePropertiesBuilder, withFlush, withInsert, withInsert, withInsertFrom, withInsertTo, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withPut, withPut, withPutBoolean, withPutByte, withPutDouble, withPutFloat, withPutInteger, withPutLong, withPutShort, withRemoveFrom, withSaveTo, withSaveTo, withSaveTo, withSaveTo, withSaveTo, withSaveTo

Methods inherited from interface org.refcodes.structure.ProfileProperties.ProfilePropertiesBuilder

toProfilePropertiesBuilder, toProfilePropertiesBuilder, toProfilePropertiesBuilder, toProfilePropertiesBuilder, toProfilePropertiesBuilder, toProfilePropertiesBuilder, toProfilePropertiesBuilder

Methods inherited from interface org.refcodes.structure.Properties.PropertiesBuilder

toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder, toPropertiesBuilder

Methods inherited from interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

toCanonicalMapBuilder, toCanonicalMapBuilder, toCanonicalMapBuilder, toCanonicalMapBuilder

Methods inherited from interface org.refcodes.structure.PathMap.PathMapBuilder

toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toPathMap, toPathMapBuilder, toPathMapBuilder, toPathMapBuilder, toPathMapBuilder

Methods inherited from interface org.refcodes.structure.Properties.MutableProperties

containsValue, delete, loadFrom, loadFrom, loadFrom, loadFrom, put, putAll, putAll, putAll

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

putAll, toDump, toSourceCode

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

insert, insert, insertFrom, insertTo, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Methods inherited from interface org.refcodes.runtime.RuntimeProperties

toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties, toRuntimeProperties

Methods inherited from interface org.refcodes.structure.ProfileProperties

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

Methods inherited from interface org.refcodes.structure.Properties

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, toDataStructure, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPathMap, toPathMap, toRootPath

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.Dumpable

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

_propertiesFile

protected File _propertiesFile

Constructor Detail

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl()

Instantiates a new runtime properties builder impl.

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl(InputStream aInputStream)
                             throws IOException

Instantiates a new runtime properties builder impl.

Parameters:

aInputStream - the a input stream

Throws:

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

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl(Map<?,?> aProperties)

Instantiates a new runtime properties builder impl.

Parameters:

aProperties - the a properties

RuntimePropertiesBuilderImpl

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

Instantiates a new runtime properties builder impl.

Parameters:

aProperties - the a properties

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl(URL aURL)
                             throws IOException

Instantiates a new runtime properties builder impl.

Parameters:

aURL - the a URL

Throws:

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

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl(File aPropertiesFile)
                             throws IOException

Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().

Parameters:

aPropertiesFile - The file of the properties file to load.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

RuntimePropertiesBuilderImpl

public RuntimePropertiesBuilderImpl(String aPropertiesFile)
                             throws IOException

Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().

Parameters:

aPropertiesFile - The file of the properties file to load.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

Method Detail

get

public String get(Object aKey)

Specified by:

get in interface Map<String,String>

Specified by:

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

Overrides:

get in class org.refcodes.structure.impls.PathMapBuilderImpl<String>

flush

public void flush()
           throws IOException

Description copied from interface: RuntimeProperties.MutableRuntimeProperties

Writes the properties back to the file from which the properties were loaded, e.g. see Properties.saveTo(File, String) or Properties.saveTo(String).

Specified by:

flush in interface RuntimeProperties.MutableRuntimeProperties

Throws:

IOException - thrown in case writing the properties back failed

retrieveFrom

public RuntimeProperties.RuntimePropertiesBuilder retrieveFrom(String aFromPath)

Description copied from interface: RuntimeProperties.RuntimePropertiesBuilder

Retrieve from.

Specified by:

retrieveFrom in interface RuntimeProperties

Specified by:

retrieveFrom in interface RuntimeProperties.MutableRuntimeProperties

Specified by:

retrieveFrom in interface RuntimeProperties.RuntimePropertiesBuilder

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

retrieveFrom in interface org.refcodes.structure.ProfileProperties

Specified by:

retrieveFrom in interface org.refcodes.structure.ProfileProperties.MutableProfileProperties

Specified by:

retrieveFrom in interface org.refcodes.structure.ProfileProperties.ProfilePropertiesBuilder

Specified by:

retrieveFrom in interface org.refcodes.structure.Properties

Specified by:

retrieveFrom in interface org.refcodes.structure.Properties.MutableProperties

Specified by:

retrieveFrom in interface org.refcodes.structure.Properties.PropertiesBuilder

Overrides:

retrieveFrom in class org.refcodes.structure.impls.ProfilePropertiesBuilderImpl

Parameters:

aFromPath - the a from path

Returns:

the runtime properties builder

retrieveTo

public RuntimeProperties.RuntimePropertiesBuilder retrieveTo(String aToPath)

Description copied from interface: RuntimeProperties.RuntimePropertiesBuilder

Retrieve to.

Specified by:

retrieveTo in interface RuntimeProperties

Specified by:

retrieveTo in interface RuntimeProperties.MutableRuntimeProperties

Specified by:

retrieveTo in interface RuntimeProperties.RuntimePropertiesBuilder

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

retrieveTo in interface org.refcodes.structure.ProfileProperties

Specified by:

retrieveTo in interface org.refcodes.structure.ProfileProperties.MutableProfileProperties

Specified by:

retrieveTo in interface org.refcodes.structure.ProfileProperties.ProfilePropertiesBuilder

Specified by:

retrieveTo in interface org.refcodes.structure.Properties

Specified by:

retrieveTo in interface org.refcodes.structure.Properties.MutableProperties

Specified by:

retrieveTo in interface org.refcodes.structure.Properties.PropertiesBuilder

Overrides:

retrieveTo in class org.refcodes.structure.impls.ProfilePropertiesBuilderImpl

Parameters:

aToPath - the a to path

Returns:

the runtime properties builder

fromFile

protected void fromFile(File aFile)
                 throws FileNotFoundException,
                        IOException

From file.

Parameters:

aFile - the a file

Throws:

FileNotFoundException - the file not found exception

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