- java.lang.Object
-
- org.refcodes.struct.PathMapBuilderImpl<String>
-
- org.refcodes.struct.CanonicalMapBuilderImpl
-
- org.refcodes.properties.PropertiesBuilderImpl
-
- org.refcodes.properties.AbstractResourcePropertiesBuilder
-
- org.refcodes.properties.TomlPropertiesBuilder
-
- All Implemented Interfaces:
Flushable
,Serializable
,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.Dictionary<String,String>
,org.refcodes.struct.Dictionary.MutableDictionary<String,String>
,org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.struct.PathMap.PathMapBuilder<String>>
,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>
public class TomlPropertiesBuilder extends AbstractResourcePropertiesBuilder implements ResourceProperties.ResourcePropertiesBuilder
Implementation of theResourceProperties.ResourcePropertiesBuilder
interface with support of so called "TOML properties". In addition, nested sections are supported: A section represents the first portion of a path and looks like such:[SectionA] ValueA=A
This results in key/value property of:SectionA/ValueA=A
[SectionA] ValueA=A [[SectionB]] ValueB=B
SectionA/ValueA=A SectionA/SectionB/ValueB=B
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TomlPropertiesBuilder.TomlPropertiesBuilderFactory
TheTomlPropertiesBuilder.TomlPropertiesBuilderFactory
represents aResourcePropertiesFactory.ResourcePropertiesBuilderFactory
creating instances of typeTomlPropertiesBuilder
.-
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.struct.Dictionary
org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,V extends Object>
-
Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary.MutableDictionary
org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<K extends Object,V extends Object,B extends org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>
-
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.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 Modifier and Type Field Description static char[]
DELIMITERS
-
Fields inherited from class org.refcodes.properties.AbstractResourcePropertiesBuilder
_propertiesFile
-
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 TomlPropertiesBuilder()
Create an emptyTomlPropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations.TomlPropertiesBuilder(File aFile)
Loads the TOML properties from the givenFile
.TomlPropertiesBuilder(File aFile, char... aDelimiters)
Loads the TOML properties from the givenFile
.TomlPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)
Loads or seeks the TOML properties from the givenFile
.TomlPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads or seeks the TOML properties from the givenFile
.TomlPropertiesBuilder(InputStream aInputStream)
Reads the TOML properties from the givenInputStream
.TomlPropertiesBuilder(InputStream aInputStream, char... aDelimiters)
Reads the TOML properties from the givenInputStream
.TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, char... aDelimiters)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(Object aObj)
Create aTomlPropertiesBuilder
instance containing the elements as ofPathMap.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.TomlPropertiesBuilder(String aFilePath)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(String aFilePath, char... aDelimiters)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads the TOML properties from the given file's path.TomlPropertiesBuilder(URL aUrl)
Loads the TOML properties from the givenURL
.TomlPropertiesBuilder(URL aUrl, char... aDelimiters)
Loads the TOML properties from the givenURL
.TomlPropertiesBuilder(Map<?,?> aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedMap
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarationsTomlPropertiesBuilder(Properties aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedProperties
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarationsTomlPropertiesBuilder(Properties.PropertiesBuilder aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedProperties.PropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected org.refcodes.struct.ext.factory.CanonicalMapFactory
createCanonicalMapFactory()
Abstract method to be implemented by the sub-classes returning the concreteCanonicalMapFactory
responsible to fabricate theCanonicalMap
instances as of the required notation.Properties
loadFrom(File aFile)
Loads the properties from the givenFile
.Properties
loadFrom(InputStream aInputStream)
Loads the properties from the givenInputStream
.void
parseFrom(String aSerialized)
Inspects the given serialized representation and adds all declared elements found.Properties
seekFrom(Class<?> aResourceClass, String aFilePath)
Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed).Properties
seekFrom(String aFilePath)
Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed).-
Methods inherited from class org.refcodes.properties.AbstractResourcePropertiesBuilder
flush, isFlushable, loadFrom, loadFrom, reload, reload, saveTo, saveTo, seekFrom, 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, 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
-
Methods inherited from class org.refcodes.properties.PropertiesBuilderImpl
retrieveFrom, retrieveTo
-
Methods inherited from class org.refcodes.struct.CanonicalMapBuilderImpl
fromInstance, fromObject, toInstance
-
Methods inherited from class org.refcodes.struct.PathMapBuilderImpl
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, createBackingMap, entrySet, equals, forEach, fromValue, fromValue, get, getAnnotator, getDelimiter, getOrDefault, getType, hashCode, insert, insertBetween, insertFrom, insertTo, isEmpty, keySet, merge, merge, mergeBetween, mergeFrom, mergeTo, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toDataStructure, toString, toType, values
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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.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 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, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, 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, 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, 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, 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, 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
reload, reload, toSerialized, toSerialized, toSerialized
-
Methods inherited from interface org.refcodes.properties.ResourceProperties.MutableResoureProperties
fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, flush, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, parseFrom, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, toSerialized
-
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 Detail
-
TomlPropertiesBuilder
public TomlPropertiesBuilder()
Create an emptyTomlPropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Object aObj)
Create aTomlPropertiesBuilder
instance containing the elements as ofPathMap.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 typeMap
,Collection
and arrays are identified and handled as of their type: The path for each value in aMap
is appended with its according key. The path for each value in aCollection
or array is appended with its according index of occurrence (in case of aList
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Properties aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedProperties
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations- Parameters:
aProperties
- the properties to be added.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Properties.PropertiesBuilder aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedProperties.PropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations- Parameters:
aProperties
- the properties to be added.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Map<?,?> aProperties)
Create aTomlPropertiesBuilder
instance containing the elements of the providedMap
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations- Parameters:
aProperties
- the properties to be added.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(File aFile) throws IOException, ParseException
Loads the TOML properties from the givenFile
.- Parameters:
aFile
- TheFile
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(File aFile, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties from the givenFile
.- Parameters:
aFile
- TheFile
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator) throws IOException, ParseException
Loads or seeks the TOML properties from the givenFile
. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Parameters:
aFile
- TheFile
from which to load the properties.aConfigLocator
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads or seeks the TOML properties from the givenFile
. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Parameters:
aFile
- TheFile
from which to load the properties.aConfigLocator
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(String aFilePath) throws IOException, ParseException
Loads the TOML properties 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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(String aFilePath, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties 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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath) throws IOException, ParseException
Loads the TOML properties 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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties 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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator) throws IOException, ParseException
Loads the TOML properties from the given file's path. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Parameters:
aFilePath
- The path to the file from which to load the properties.aConfigLocator
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties from the given file's path. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Parameters:
aFilePath
- The path to the file from which to load the properties.aConfigLocator
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator) throws IOException, ParseException
Loads the TOML properties from the given file's path. A providedConfigLocator
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
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties from the given file's path. A providedConfigLocator
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
- TheConfigLocator
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(URL aUrl) throws IOException, ParseException
Loads the TOML properties from the givenURL
.- Parameters:
aUrl
- TheURL
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(URL aUrl, char... aDelimiters) throws IOException, ParseException
Loads the TOML properties from the givenURL
.- Parameters:
aUrl
- TheURL
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(InputStream aInputStream) throws IOException, ParseException
Reads the TOML properties from the givenInputStream
.- Parameters:
aInputStream
- TheInputStream
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.
-
TomlPropertiesBuilder
public TomlPropertiesBuilder(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException
Reads the TOML properties from the givenInputStream
.- Parameters:
aInputStream
- TheInputStream
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.
-
-
Method Detail
-
loadFrom
public Properties loadFrom(File aFile) throws IOException, ParseException
Loads the properties from the givenFile
. Save them using the methodResourceProperties.MutableResoureProperties.saveTo(File)
. The default implementation uses the hook methodResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
to finally load and parse the properties.- Specified by:
loadFrom
in interfaceResourceProperties.MutableResoureProperties
- Parameters:
aFile
- TheFile
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 failedParseException
- 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 givenInputStream
. Save them using the methodResourceProperties.MutableResoureProperties.saveTo(OutputStream)
. The default implementation uses the hook methodResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
to finally load and parse the properties.- Specified by:
loadFrom
in interfaceResourceProperties.MutableResoureProperties
- Parameters:
aInputStream
- TheInputStream
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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
parseFrom
public void parseFrom(String aSerialized) throws ParseException
Inspects the given serialized representation and adds all declared elements found. Unmarshaled elements of typeMap
,Collection
and arrays are identified and handled as of their type: The path for each value in aMap
is appended with its according key. The path for each value in aCollection
or array is appended with its according index of occurrence (in case of aList
or an array, its actual index). The default implementation uses the hook methodResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
to finally load and parse the properties.- Specified by:
parseFrom
in interfaceResourceProperties.MutableResoureProperties
- Parameters:
aSerialized
- The serialized representation which is to be parsed for the therein declared elements being added with their according determined paths.- Throws:
ParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
seekFrom
public Properties seekFrom(String aFilePath) 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 specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
to finally load and parse the properties.- Specified by:
seekFrom
in interfaceResourceProperties.MutableResoureProperties
- 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 accessing or processing the properties file 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) 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 specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). 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 methodResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
to finally load and parse the properties.- Specified by:
seekFrom
in interfaceResourceProperties.MutableResoureProperties
- 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.- 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.
-
createCanonicalMapFactory
protected org.refcodes.struct.ext.factory.CanonicalMapFactory createCanonicalMapFactory()
Abstract method to be implemented by the sub-classes returning the concreteCanonicalMapFactory
responsible to fabricate theCanonicalMap
instances as of the required notation.- Specified by:
createCanonicalMapFactory
in classAbstractResourcePropertiesBuilder
- Returns:
- The
CanonicalMapFactory
supporting the required notation.
-
-