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

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 the ConfigLocator (if not provided, then
ConfigLocator.ALL is assumed).

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 the ConfigLocator (if not provided, then
ConfigLocator.ALL is assumed).

COMMENTS

DELIMITERS

Constructor Detail

TomlPropertiesBuilder

Create an empty TomlPropertiesBuilder instance using the default
path delimiter "/" (Delimiter.PATH) for the path declarations.

TomlPropertiesBuilder

public TomlPropertiesBuilder​(java.lang.Object aObj)

Create a TomlPropertiesBuilder 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."

TomlPropertiesBuilder

Loads the TOML properties 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.

Loads the TOML properties 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.

parseFrom

Inspects the given serialized representation and adds all declared
elements found. Unmarshaled 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).
The default implementation uses the hook method
ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the
properties.

seekFrom

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 the ConfigLocator (if not provided, then
ConfigLocator.ALL is assumed).
The default implementation uses the hook method
ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the
properties.

seekFrom

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 the ConfigLocator (if not provided, then
ConfigLocator.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 method
ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) to finally load and parse the
properties.

loadFrom

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.

saveTo

Saves the properties to the given OutputStream using the
provided delimiter as the destination's path delimiter. Load them via
ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...)
This is the hook-method of the default implementation for writing
(saving) 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.