org.refcodes.runtime

Interface RuntimeProperties

All Superinterfaces:

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

All Known Subinterfaces:

RuntimeProperties.MutableRuntimeProperties, RuntimeProperties.RuntimePropertiesBuilder

All Known Implementing Classes:

RuntimePropertiesBuilderImpl, RuntimePropertiesImpl

public interface RuntimeProperties
extends org.refcodes.structure.ProfileProperties

The Interface RuntimeProperties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RuntimeProperties.MutableRuntimeProperties The Interface MutableRuntimeProperties.
static interface	RuntimeProperties.RuntimePropertiesBuilder The Interface 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 inherited from interface org.refcodes.structure.ProfileProperties

RUNTIME_PROFILES_PATH

Fields inherited from interface org.refcodes.structure.Properties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method and Description
default RuntimeProperties	retrieve(String aFromPath, String aToPath) Retrieve.
RuntimeProperties	retrieveFrom(String aFromPath) Retrieve from.
RuntimeProperties	retrieveTo(String aToPath) Retrieve to.
static RuntimeProperties	toRuntimeProperties(File aFile) 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().
static RuntimeProperties	toRuntimeProperties(InputStream aInputStream) Loads the properties from the given InputStream.
static RuntimeProperties	toRuntimeProperties(Map<?,?> aProperties) Creates a PropertiesBuilder instance filled with the provided Properties.
static RuntimeProperties	toRuntimeProperties(org.refcodes.structure.Properties aProperties) Creates a PropertiesBuilder instance filled with the provided Properties.
static RuntimeProperties	toRuntimeProperties(String aFilePath) 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().
static RuntimeProperties	toRuntimeProperties(URL aURL) Loads the properties from the given URL.

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

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

Methods inherited from interface org.refcodes.structure.Keys

containsKey, get, keySet, values

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, toDump

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

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

Method Detail

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(org.refcodes.structure.Properties aProperties)

Creates a PropertiesBuilder instance filled with the provided Properties.

Parameters:

aProperties - the a properties

Returns:

The according ProfileProperties.

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(Map<?,?> aProperties)

Creates a PropertiesBuilder instance filled with the provided Properties.

Parameters:

aProperties - the a properties

Returns:

The according RuntimeProperties.

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(InputStream aInputStream)
                                      throws IOException

Loads the properties from the given InputStream. Save them using the method Properties.saveTo(OutputStream).

Parameters:

aInputStream - The InputStream from which to load the properties.

Returns:

The according RuntimeProperties.

Throws:

IOException - thrown in case loading the properties failed

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(URL aURL)
                                      throws IOException

Loads the properties from the given URL.

Parameters:

aURL - The URL from which to load the properties.

Returns:

The according RuntimeProperties.

Throws:

IOException - thrown in case loading the properties failed

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(String aFilePath)
                                      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:

aFilePath - The file path from which to load the properties.

Returns:

the runtime properties

Throws:

IOException - thrown in case loading the properties failed

toRuntimeProperties

static RuntimeProperties toRuntimeProperties(File aFile)
                                      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:

aFile - The File from which to load the properties.

Returns:

the runtime properties

Throws:

IOException - thrown in case loading the properties failed

retrieveFrom

RuntimeProperties retrieveFrom(String aFromPath)

Retrieve from.

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

RuntimeProperties retrieveTo(String aToPath)

Retrieve to.

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

retrieve

default RuntimeProperties retrieve(String aFromPath,
                                   String aToPath)

Retrieve.

Specified by:

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

Specified by:

retrieve in interface org.refcodes.structure.ProfileProperties

Specified by:

retrieve in interface org.refcodes.structure.Properties

Parameters:

aFromPath - the a from path

aToPath - the a to path

Returns:

the runtime properties