org.refcodes.configuration

Class EnvironmentProperties

java.lang.Object

org.refcodes.configuration.PropertiesImpl

org.refcodes.configuration.EnvironmentProperties

All Implemented Interfaces:

Properties, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.TypeAccessor<String>, 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.PropertiesAccessorMixin

public class EnvironmentProperties
extends PropertiesImpl
implements Properties

Extension of the Properties type overwriting methods in order to access the operating system's environment variables as of env on Linux or Unix shells or set on Windows machines (e.g."set JAVA_HOME=/opt/java9"). The keys are transformed to an environment variable by removing a prefixed "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_". If accessing failed, then the upper case version of the so transformed key is probed. Accessing an environment variable "JAVA_HOME" would be done with the path "/java/home".

Nested Class Summary

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

Properties.MutableProperties, 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.PropertiesBuilderMixin<T>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Field Summary

Fields inherited from class org.refcodes.configuration.PropertiesImpl

_properties

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor and Description
EnvironmentProperties()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object aKey) The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_".
String	get(Object aKey) The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_".
Set<String>	keySet() The keys are transformed to a path by prefixing a "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other environment variable's (de facto standard) separators "_" to the path delimiter "/".
int	size()
Collection<String>	values()

Methods inherited from class org.refcodes.configuration.PropertiesImpl

childrenOf, getDelimiter, getType, isEmpty, retrieveFrom, retrieveTo, toDataStructure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.configuration.Properties

childrenOf, containsValue, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.PathMap

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

Methods inherited from interface org.refcodes.structure.Keys

use

Methods inherited from interface org.refcodes.structure.Containable

isEmpty

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Constructor Detail

EnvironmentProperties

public EnvironmentProperties()

Method Detail

get

public String get(Object aKey)

The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_". If accessing failed, then the upper case version of the so transformed key is probed.

Specified by:

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

Overrides:

get in class PropertiesImpl

containsKey

public boolean containsKey(Object aKey)

The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_". If accessing failed, then the upper case version of the so transformed key is probed.

Specified by:

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

Overrides:

containsKey in class PropertiesImpl

keySet

public Set<String> keySet()

The keys are transformed to a path by prefixing a "/" path delimiter (as of PropertiesImpl.getDelimiter() and converting all other environment variable's (de facto standard) separators "_" to the path delimiter "/".

Specified by:

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

Overrides:

keySet in class PropertiesImpl

values

public Collection<String> values()

Specified by:

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

Overrides:

values in class PropertiesImpl

size

public int size()

Specified by:

size in interface org.refcodes.structure.Containable

Overrides:

size in class PropertiesImpl