Class MapImmutableProperties

java.lang.Object

org.refcodes.properties.MapImmutableProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

ArgsProperties

public class MapImmutableProperties
extends Object
implements ImmutableProperties

The Class MapImmutableProperties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapImmutableProperties.Builder	Builder for collecting properties and creating ImmutableProperties instances.

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

Modifier and Type	Field	Description
protected Properties	_properties

Fields inherited from interface ImmutablePathTable

ANNOTATOR, DELIMITER

Fields inherited from interface ImmutableProperties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
MapImmutableProperties()	Creates an empty immutable ImmutableProperties object.
MapImmutableProperties(Object aObj)	Create a ImmutableProperties instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object.
MapImmutableProperties(Map<?,?> aProperties)	Create a ImmutableProperties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapImmutableProperties(Properties aProperties)	Create a Properties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapImmutableProperties(Property... aProperties)	Create a ImmutableProperties instance containing the provided Property instances' key/value-pairs.

Method Summary

Modifier and Type	Method	Description
static MapImmutableProperties.Builder	builder()	Creates a new MapImmutableProperties.Builder for constructing ImmutableProperties instances.
boolean	containsKey(Object aKey)
boolean	equals(Object obj)
String	get(Object aKey)
char	getDelimiter()	Returns the default path delimiter as of Delimiter.PATH.
Class<String>	getType()
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
int	size()
Object	toDataStructure(String aFromPath)
Collection<String>	values()

Methods inherited from class Object

clone, finalize, getClass, 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, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, 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

Field Details

_properties

protected Properties _properties

Constructor Details

MapImmutableProperties

public MapImmutableProperties()

Creates an empty immutable ImmutableProperties object.

MapImmutableProperties

public MapImmutableProperties(Map<?,?> aProperties)

Create a ImmutableProperties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aProperties - the properties to be added.

MapImmutableProperties

public MapImmutableProperties(Object aObj)

Create a ImmutableProperties instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object. Elements of type Map, Collection and arrays are identified and handled as of their type: The path for each value in a Map is appended with its according key. The path for each value in a Collection or array is appended with its according index of occurrence (in case of a List or an array, its actual index). In case of reflection, the path for each member is appended with its according mamber's name. All elements (e.g. the members and values) are inspected recursively which results in the according paths of the terminating values."

Parameters:

aObj - The object from which the elements are to be added.

MapImmutableProperties

public MapImmutableProperties(Properties aProperties)

Create a Properties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aProperties - the properties to be added.

MapImmutableProperties

public MapImmutableProperties(Property... aProperties)

Create a ImmutableProperties instance containing the provided Property instances' key/value-pairs.

Parameters:

aProperties - the properties to be added.

Method Details

containsKey

public boolean containsKey(Object aKey)

Specified by:

containsKey in interface Keys<String,String>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

get

public String get(Object aKey)

Specified by:

get in interface Keys<String,String>

getDelimiter

public char getDelimiter()

Returns the default path delimiter as of Delimiter.PATH.

Specified by:

getDelimiter in interface DelimiterAccessor

Specified by:

getDelimiter in interface ImmutableProperties

getType

public Class<String> getType()

Specified by:

getType in interface ImmutableProperties

Specified by:

getType in interface TypeAccessor<String>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface EmptyAccessor

keySet

public Set<String> keySet()

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>

builder

public static MapImmutableProperties.Builder builder()

Creates a new MapImmutableProperties.Builder for constructing ImmutableProperties instances.

Returns:

A new builder instance