Module org.refcodes.properties

Package org.refcodes.properties

Class PolyglotPropertiesBuilder

java.lang.Object

org.refcodes.properties.AbstractPropertiesDecorator<T>

org.refcodes.properties.AbstractPropertiesBuilderDecorator<T>

org.refcodes.properties.AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

org.refcodes.properties.PolyglotPropertiesBuilder

All Implemented Interfaces:

Flushable, Map<String,String>, org.refcodes.component.Flushable, org.refcodes.component.Flushable.FlushBuilder<ResourceProperties.ResourcePropertiesBuilder>, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.Clearable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<String>, Properties, Properties.MutableProperties, Properties.PropertiesBuilder, ResourceProperties, ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder, org.refcodes.struct.CanonicalMap, org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.struct.Keys.MutableKeys<String,String>, org.refcodes.struct.Keys.MutableValues<String,String>, org.refcodes.struct.PathMap<String>, org.refcodes.struct.PathMap.MutablePathMap<String>, org.refcodes.struct.PathMap.PathMapBuilder<String>, org.refcodes.struct.Table<String,String>, org.refcodes.struct.Table.TableDictionary<String,String>, org.refcodes.struct.Table.TableDictionary.TableBuilder<String,String,org.refcodes.struct.PathMap.PathMapBuilder<String>>

public class PolyglotPropertiesBuilder
extends AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "PolyglotPropertiesBuilder" (or just "properties"). For PolyglotPropertiesBuilder, see "https://en.wikipedia.org/wiki/.properties".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory	The PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory is a meta factory using a collection of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances to deliver ResourceProperties.ResourcePropertiesBuilder instances.

Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.CanonicalMap

org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap

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.EmptyAccessor

org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Flushable

org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.PathMap

org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

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

Properties.MutableProperties, Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.properties.ResourceProperties

ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.struct.Table

org.refcodes.struct.Table.TableDictionary<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Table.TableDictionary

org.refcodes.struct.Table.TableDictionary.TableBuilder<K extends Object,V extends Object,B extends org.refcodes.struct.Table.TableDictionary.TableBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Fields inherited from interface org.refcodes.properties.Properties

DEFAULT_COMMENT

Fields inherited from interface org.refcodes.properties.ResourceProperties.MutableResoureProperties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
PolyglotPropertiesBuilder(File aFile)	Loads the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(File aFile, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads or seeks the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads or seeks the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(InputStream aInputStream)	Reads the PolyglotPropertiesBuilder from the given InputStream.
PolyglotPropertiesBuilder(InputStream aInputStream, char... aDelimiters)	Reads the PolyglotPropertiesBuilder from the given InputStream.
PolyglotPropertiesBuilder(Class<?> aResourceClass, String aFilePath)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(Class<?> aResourceClass, String aFilePath, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(Object aObj)	Create a PolyglotPropertiesBuilder instance containing the elements as of PathMap.MutablePathMap.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.
PolyglotPropertiesBuilder(String aFilePath)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(String aFilePath, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(URL aUrl)	Loads the PolyglotPropertiesBuilder from the given URL.
PolyglotPropertiesBuilder(URL aUrl, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given URL.
PolyglotPropertiesBuilder(Map<?,?> aMap)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, File aFile)	Loads the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, File aFile, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads or seeks the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads or seeks the PolyglotPropertiesBuilder from the given File.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, InputStream aInputStream)	Reads the PolyglotPropertiesBuilder from the given InputStream.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, InputStream aInputStream, char... aDelimiters)	Reads the PolyglotPropertiesBuilder from the given InputStream.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Class<?> aResourceClass, String aFilePath)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Class<?> aResourceClass, String aFilePath, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Object aObj)	Create a PolyglotPropertiesBuilder instance containing the elements as of PathMap.MutablePathMap.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.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aFilePath)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aFilePath, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given file's path.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, URL aUrl)	Loads the PolyglotPropertiesBuilder from the given URL.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, URL aUrl, char... aDelimiters)	Loads the PolyglotPropertiesBuilder from the given URL.
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Map<?,?> aPropertiesBuilder)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Properties aProperties)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, Properties.PropertiesBuilder aPropertiesBuilder)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Properties.PropertiesBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
PolyglotPropertiesBuilder(Properties aProperties)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
PolyglotPropertiesBuilder(Properties.PropertiesBuilder aPropertiesBuilder)	Create a PolyglotPropertiesBuilder instance containing the elements of the provided Properties.PropertiesBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations

Method Summary

Modifier and Type	Method	Description
Properties	loadFrom(File aFile)	Loads the properties from the given File.
Properties	loadFrom(File aFile, char... aDelimiters)	Loads the properties from the given File.
Properties	loadFrom(InputStream aInputStream)	Loads the properties from the given InputStream.
Properties	loadFrom(InputStream aInputStream, char... aDelimiters)	Loads the properties from the given InputStream.
Properties	loadFrom(Class<?> aResourceClass, String aFilePath)	Loads the properties from the given class resource (from inside a JAR).
Properties	loadFrom(Class<?> aResourceClass, String aFilePath, char... aDelimiters)	Loads the properties from the given class resource (from inside a JAR).
Properties	loadFrom(String aFilePath)	Loads the properties from the given file path's File.
Properties	loadFrom(String aFilePath, char... aDelimiters)	Loads the properties from the given file path's File.
Properties	loadFrom(URL aUrl)	Loads the properties from the given URL.
Properties	loadFrom(URL aUrl, char... aDelimiters)	Loads the properties from the given URL.
Properties	reload()	Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
Properties	reload(ReloadMode aReloadMode)	Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
Properties	seekFrom(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)	Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator configuration passed.

Methods inherited from class org.refcodes.properties.AbstractResourcePropertiesBuilderDecorator

flush, isFlushable, saveTo, saveTo, toSerialized

Methods inherited from class org.refcodes.properties.AbstractPropertiesBuilderDecorator

clear, containsValue, entrySet, insert, insertBetween, insertFrom, insertTo, merge, mergeBetween, mergeFrom, mergeTo, put, putAll, remove

Methods inherited from class org.refcodes.properties.AbstractPropertiesDecorator

containsKey, get, getAnnotator, getDelimiter, getProperties, isEmpty, keySet, retrieveFrom, retrieveTo, setProperties, size, toDataStructure, toDump, toDump, toPrintable, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.struct.CanonicalMap

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 org.refcodes.struct.CanonicalMap.MutableCanonicalMap

containsValue, insert, insertBetween, insertFrom, insertTo, put, put, put, put, putAll, removeFrom, toDump

Methods inherited from interface org.refcodes.mixin.Clearable

clear

Methods inherited from interface org.refcodes.struct.Containable

size

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked

Methods inherited from interface org.refcodes.component.Flushable.FlushBuilder

withFlush, withFlushUnchecked

Methods inherited from interface org.refcodes.struct.InterOperableMap

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 org.refcodes.struct.InterOperableMap.MutableInterOperableMap

containsValue, insert, insertBetween, insertFrom, insertTo, putBoolean, putBoolean, putBoolean, putBoolean, putBoolean, putByte, putByte, putByte, putByte, putByte, putChar, putChar, putChar, putChar, putChar, putClass, putClass, putClass, putClass, putClass, putDouble, putDouble, putDouble, putDouble, putDouble, putEnum, putEnum, putEnum, putEnum, putEnum, putFloat, putFloat, putFloat, putFloat, putFloat, putInt, putInt, putInt, putInt, putInt, putLong, putLong, putLong, putLong, putLong, putShort, putShort, putShort, putShort, putShort, putString, putString, putString, putString, putString

Methods inherited from interface org.refcodes.struct.Keys

containsKey, get, getOr, keySet, use, values

Methods inherited from interface org.refcodes.struct.Keys.MutableValues

put

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.refcodes.struct.PathMap

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, 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 org.refcodes.struct.PathMap.MutablePathMap

add, add, add, add, add, add, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, delete, delete, delete, delete, delete, fromType, fromType, fromType, fromType, fromType, fromType, fromType, fromType, insert, insert, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, merge, merge, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, put, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, remove, remove, remove, removeValueAt, removeValueAt, removeValueAt, removeValueAt, removeValueAt, toSourceCode, toSourceCode

Methods inherited from interface org.refcodes.properties.Properties

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, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo, retrieveTo

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

containsValue, delete, insert, insert, insertBetween, insertFrom, insertTo, put, putAll, putAll, putAll, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeDirAt, removeDirAt, removeDirAt, removeDirAt, removeDirAt, removeFrom, removeFrom, removeFrom, removeFrom, removePaths, removePaths

Methods inherited from interface org.refcodes.properties.ResourceProperties

toSerialized, toSerialized, toSerialized

Methods inherited from interface org.refcodes.properties.ResourceProperties.MutableResoureProperties

fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, parseFrom, parseFrom, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom

Methods inherited from interface org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder

withInsert, withInsert, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withMerge, withMerge, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withPut, withPut, withPut, withPut, withPut, withPut, withPutBoolean, withPutBoolean, withPutBoolean, withPutBoolean, withPutBoolean, withPutByte, withPutByte, withPutByte, withPutByte, withPutByte, withPutChar, withPutChar, withPutChar, withPutChar, withPutChar, withPutClass, withPutClass, withPutClass, withPutClass, withPutClass, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDouble, withPutDouble, withPutDouble, withPutDouble, withPutDouble, withPutEnum, withPutEnum, withPutEnum, withPutEnum, withPutEnum, withPutFloat, withPutFloat, withPutFloat, withPutFloat, withPutFloat, withPutInt, withPutInt, withPutInt, withPutInt, withPutInt, withPutLong, withPutLong, withPutLong, withPutLong, withPutLong, withPutShort, withPutShort, withPutShort, withPutShort, withPutShort, withPutString, withPutString, withPutString, withPutString, withPutString, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemovePaths, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom

Constructor Details

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Object aObj)

Create a PolyglotPropertiesBuilder instance containing the elements as of PathMap.MutablePathMap.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.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Properties aProperties)

Create a PolyglotPropertiesBuilder 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.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Properties.PropertiesBuilder aPropertiesBuilder)

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

Parameters:

aPropertiesBuilder - the properties to be added.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Map<?,?> aMap)

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

Parameters:

aMap - the properties to be added.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(File aFile)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given File.

Parameters:

aFile - The File from which to load the properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(File aFile,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given File.

Parameters:

aFile - The File from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(File aFile,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads or seeks the PolyglotPropertiesBuilder from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

aFile - The File from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(File aFile,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads or seeks the PolyglotPropertiesBuilder from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

aFile - The File from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(String aFilePath)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

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

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(String aFilePath,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

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

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Class<?> aResourceClass,
 String aFilePath)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Class<?> aResourceClass,
 String aFilePath,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

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

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

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

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(URL aUrl)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given URL.

Parameters:

aUrl - The URL from which to read the properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(URL aUrl,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given URL.

Parameters:

aUrl - The URL from which to read the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(InputStream aInputStream)
                          throws IOException,
ParseException

Reads the PolyglotPropertiesBuilder from the given InputStream.

Parameters:

aInputStream - The InputStream from which to read the properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(InputStream aInputStream,
 char... aDelimiters)
                          throws IOException,
ParseException

Reads the PolyglotPropertiesBuilder from the given InputStream.

Parameters:

aInputStream - The InputStream from which to read the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Object aObj)

Create a PolyglotPropertiesBuilder instance containing the elements as of PathMap.MutablePathMap.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:

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

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

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Properties aProperties)

Create a PolyglotPropertiesBuilder 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.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Properties.PropertiesBuilder aPropertiesBuilder)

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

Parameters:

aPropertiesBuilder - the properties to be added.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Map<?,?> aPropertiesBuilder)

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

Parameters:

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

aPropertiesBuilder - the properties to be added.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 File aFile)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given File.

Parameters:

aFile - The File from which to load the properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 File aFile,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given File.

Parameters:

aFile - The File from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 File aFile,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads or seeks the PolyglotPropertiesBuilder from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

aFile - The File from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 File aFile,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads or seeks the PolyglotPropertiesBuilder from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

aFile - The File from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 String aFilePath)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

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

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 String aFilePath,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

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

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Class<?> aResourceClass,
 String aFilePath)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Class<?> aResourceClass,
 String aFilePath,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

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

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Parameters:

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

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 URL aUrl)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given URL.

Parameters:

aUrl - The URL from which to read the properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 URL aUrl,
 char... aDelimiters)
                          throws IOException,
ParseException

Loads the PolyglotPropertiesBuilder from the given URL.

Parameters:

aUrl - The URL from which to read the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 InputStream aInputStream)
                          throws IOException,
ParseException

Reads the PolyglotPropertiesBuilder from the given InputStream.

Parameters:

aInputStream - The InputStream from which to read the properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

PolyglotPropertiesBuilder

public PolyglotPropertiesBuilder(PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
 InputStream aInputStream,
 char... aDelimiters)
                          throws IOException,
ParseException

Reads the PolyglotPropertiesBuilder from the given InputStream.

Parameters:

aInputStream - The InputStream from which to read the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties.

aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties.ResourcePropertiesBuilder instances.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

Method Details

loadFrom

public Properties loadFrom(Class<?> aResourceClass,
 String aFilePath)
                    throws IOException,
ParseException

Loads the properties from the given class resource (from inside a JAR). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(Class<?> aResourceClass,
 String aFilePath,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads the properties from the given class resource (from inside a JAR). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(File aFile)
                    throws IOException,
ParseException

Loads the properties from the given File. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(File). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aFile - The File from which to load the properties.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(InputStream aInputStream)
                    throws IOException,
ParseException

Loads the properties from the given InputStream. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(OutputStream). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aInputStream - The InputStream from which to load the properties.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(String aFilePath)
                    throws IOException,
ParseException

Loads the properties from the given file path's File. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(String). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

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

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded..

loadFrom

public Properties loadFrom(String aFilePath,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads the properties from the given file path's File. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(String, char). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

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

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(URL aUrl)
                    throws IOException,
ParseException

Loads the properties from the given URL. The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aUrl - The URL from which to load the properties.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(URL aUrl,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads the properties from the given URL. The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Parameters:

aUrl - The URL from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(File aFile,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads the properties from the given File. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(File). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Specified by:

loadFrom in interface ResourceProperties.MutableResoureProperties

Overrides:

loadFrom in class AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Parameters:

aFile - The File from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

loadFrom

public Properties loadFrom(InputStream aInputStream,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads the properties from the given InputStream. Save them using the method ResourceProperties.MutableResoureProperties.saveTo(OutputStream). This is the hook-method of the default implementation for loading the properties. In case you want to implement ResourceProperties which support other notations than the properties notation (path=value), then you overwrite this method in your implementation accordingly.

Specified by:

loadFrom in interface ResourceProperties.MutableResoureProperties

Overrides:

loadFrom in class AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Parameters:

aInputStream - The InputStream from which to load the properties.

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case loading the properties failed

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

seekFrom

public Properties seekFrom(Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.ConfigLocator aConfigLocator,
 char... aDelimiters)
                    throws IOException,
ParseException

Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator configuration passed. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed). The default implementation uses the hook method ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the properties.

Specified by:

seekFrom in interface ResourceProperties.MutableResoureProperties

Overrides:

seekFrom in class AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

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

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

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

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

reload

public Properties reload()
                  throws IOException,
ParseException

Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)). In case the resource (such as an InputStream) does not support reloading, then an IllegalStateException is thrown. Properties existing in the attached resource as well in the Properties itself are replaced. Properties existing in the attached resource but not(!) in the Properties itself are not(!) removed. Use ResourceProperties.reload(ReloadMode) with an argument of true (~ orphan removal) to remove properties not existing in the resource. Attention: Reloads only the initially loaded properties!

Specified by:

reload in interface ResourceProperties

Overrides:

reload in class AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case accessing the resource encountered an I/O problem.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

reload

public Properties reload(ReloadMode aReloadMode)
                  throws IOException,
ParseException

Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)). In case the resource (such as an InputStream) does not support reloading, then an IllegalStateException is thrown. Properties existing in the attached resource as well in the Properties itself are replaced. When "orphan removal" is set to false, then properties existing in the attached resource but not(!) in the Properties itself are not(!) removed. When "orphan removal" is set to true, then properties existing in the attached resource but not(!) in the Properties itself are(!) removed. Attention: Reloads only the initially loaded properties!

Specified by:

reload in interface ResourceProperties

Overrides:

reload in class AbstractResourcePropertiesBuilderDecorator<ResourceProperties.ResourcePropertiesBuilder>

Parameters:

aReloadMode - when set to ReloadMode.ORPHAN_REMOVAL, then properties existing in the attached resource but not(!) in the Properties itself are(!) removed. Else properties not existing in the attached resource are kept.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

IOException - thrown in case accessing the resource encountered an I/O problem.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.