Class EnvironmentProperties

java.lang.Object

org.refcodes.properties.EnvironmentProperties

All Implemented Interfaces:

AnnotatorAccessor, DelimiterAccessor, EmptyAccessor, TypeAccessor<String>, ImmutableProperties, Containable, ImmutableCanonicalTable, ImmutableInterOperableTable<String>, ImmutablePathTable<String>, ImmutableTable<String,String>, Keys<String,String>

public class EnvironmentProperties
extends Object
implements ImmutableProperties

Extension of the ImmutableProperties 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 ImmutableProperties.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 AnnotatorAccessor

AnnotatorAccessor.AnnotatorBuilder<B>, AnnotatorAccessor.AnnotatorMutator, AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface DelimiterAccessor

DelimiterAccessor.DelimiterBuilder<B>, DelimiterAccessor.DelimiterMutator, DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface EmptyAccessor

EmptyAccessor.EmptyBuilder<B>, EmptyAccessor.EmptyMutator, EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface ImmutableCanonicalTable

ImmutableCanonicalTable.MutableCanonicalTable

Nested classes/interfaces inherited from interface ImmutableInterOperableTable

ImmutableInterOperableTable.MutableInterOperableTable<T>

Nested classes/interfaces inherited from interface ImmutablePathTable

ImmutablePathTable.MutablePathTable<T>

Nested classes/interfaces inherited from interface ImmutableProperties

ImmutableProperties.MutableProperties

Nested classes/interfaces inherited from interface ImmutableTable

ImmutableTable.MutableTable<K,V>

Nested classes/interfaces inherited from interface Keys

Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>

Nested classes/interfaces inherited from interface TypeAccessor

TypeAccessor.TypeBuilder<T,B>, TypeAccessor.TypeMutator<T>, TypeAccessor.TypeProperty<T>

Field Summary

Fields inherited from interface ImmutablePathTable

ANNOTATOR, DELIMITER

Fields inherited from interface ImmutableProperties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
EnvironmentProperties()

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object aKey)	The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of ImmutableProperties.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 ImmutableProperties.getDelimiter() and converting all other path delimiters "/" to the environment variable's (de facto standard) separator "_".
boolean	isEmpty()
Set<String>	keySet()	The keys are transformed to a path by prefixing a "/" path delimiter (as of ImmutableProperties.getDelimiter() and converting all other environment variable's (de facto standard) separators "_" to the path delimiter "/".
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
int	size()
Object	toDataStructure(String aFromPath)
Collection<String>	values()

Methods inherited from class Object

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

Methods inherited from interface ImmutableCanonicalTable

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

Methods inherited from interface ImmutableInterOperableTable

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface ImmutablePathTable

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPrintable, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

Methods inherited from interface ImmutableProperties

containsValue, getAnnotator, getDelimiter, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getType, query, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo

Methods inherited from interface Keys

getOr

Constructor Details

EnvironmentProperties

public EnvironmentProperties()

Method Details

containsKey

public boolean containsKey(Object aKey)

The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of ImmutableProperties.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 Keys<String,String>

get

public String get(Object aKey)

The key is transformed to an environment variable by removing a prefixed "/" path delimiter (as of ImmutableProperties.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 Keys<String,String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface EmptyAccessor

keySet

public Set<String> keySet()

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

Specified by:

keySet in interface Keys<String,String>

retrieveFrom

public Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface ImmutableCanonicalTable

Specified by:

retrieveFrom in interface ImmutablePathTable<String>

Specified by:

retrieveFrom in interface ImmutableProperties

retrieveTo

public Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface ImmutableCanonicalTable

Specified by:

retrieveTo in interface ImmutablePathTable<String>

Specified by:

retrieveTo in interface ImmutableProperties

size

public int size()

Specified by:

size in interface Containable

toDataStructure

public Object toDataStructure(String aFromPath)

Specified by:

toDataStructure in interface ImmutablePathTable<String>

values

public Collection<String> values()

Specified by:

values in interface Keys<String,String>