Flushable
, Serializable
, Cloneable
, Map<String,T>
, org.refcodes.component.Flushable
, org.refcodes.component.Flushable.FlushBuilder<String>
, Properties
, Properties.MutableProperties
, Properties.PropertiesBuilder
, ResourceProperties
, ResourceProperties.MutableResoureProperties
, ResourceProperties.ResourcePropertiesBuilder
, org.refcodes.mixin.DelimiterAccessor
, org.refcodes.mixin.Dumpable
, org.refcodes.mixin.TypeAccessor<String>
, org.refcodes.structure.CanonicalMap
, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder
, org.refcodes.structure.CanonicalMap.MutableCanonicalMap
, org.refcodes.structure.Clearable
, org.refcodes.structure.Containable
, org.refcodes.structure.Dictionary<String,T>
, org.refcodes.structure.Dictionary.MutableDictionary<String,T>
, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,T,org.refcodes.structure.PathMap.PathMapBuilder<T>>
, org.refcodes.structure.Keys<String,T>
, org.refcodes.structure.Keys.MutableKeys<String,T>
, org.refcodes.structure.Keys.MutableValues<String,T>
, org.refcodes.structure.PathMap<String>
, org.refcodes.structure.PathMap.MutablePathMap<String>
, org.refcodes.structure.PathMap.PathMapBuilder<String>
, org.refcodes.structure.PropertiesAccessorMixin
, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<String>
, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin
, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
public class YamlPropertiesBuilder extends AbstractResourcePropertiesBuilder implements ResourceProperties.ResourcePropertiesBuilder
ResourceProperties.ResourcePropertiesBuilder
interface with
support of so called "YAML properties" (or just "properties").
For YAML, see "https://en.wikipedia.org/wiki/YAML".AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap
org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty
org.refcodes.structure.Dictionary.MutableDictionary<K extends Object,V extends Object>
org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends Object,V extends Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>
org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>
org.refcodes.structure.PathMap.MutablePathMap<T extends Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends Object>
Properties.MutableProperties, Properties.PropertiesBuilder
org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder
Modifier and Type | Field | Description |
---|---|---|
static char |
COMMENT |
_propertiesFile
DEFAULT_COMMENT
Constructor | Description |
---|---|
YamlPropertiesBuilder() |
Create an empty
YamlPropertiesBuilder instance using the
default path delimiter "/" (Delimiter.PATH ) for the path
declarations. |
YamlPropertiesBuilder(File aFile) |
Loads the YAML properties from the given
File . |
YamlPropertiesBuilder(File aFile,
boolean isSeekFile) |
Loads or seeks the YAML properties from the given
File . |
YamlPropertiesBuilder(File aFile,
boolean isSeekFile,
char... aDelimiters) |
Loads or seeks the YAML properties from the given
File . |
YamlPropertiesBuilder(File aFile,
char... aDelimiters) |
Loads the YAML properties from the given
File . |
YamlPropertiesBuilder(InputStream aInputStream) |
Reads the YAML properties from the given
InputStream . |
YamlPropertiesBuilder(InputStream aInputStream,
char... aDelimiters) |
Reads the YAML properties from the given
InputStream . |
YamlPropertiesBuilder(Class<?> aResourceClass,
String aFilePath) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(Class<?> aResourceClass,
String aFilePath,
boolean isSeekFile) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(Class<?> aResourceClass,
String aFilePath,
boolean isSeekFile,
char... aDelimiters) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(Class<?> aResourceClass,
String aFilePath,
char... aDelimiters) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(Object aObj) |
Create a
YamlPropertiesBuilder 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. |
YamlPropertiesBuilder(String aFilePath) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(String aFilePath,
boolean isSeekFile) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(String aFilePath,
boolean isSeekFile,
char... aDelimiters) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(String aFilePath,
char... aDelimiters) |
Loads the YAML properties from the given file's path.
|
YamlPropertiesBuilder(URL aUrl) |
Loads the YAML properties from the given
URL . |
YamlPropertiesBuilder(URL aUrl,
char... aDelimiters) |
Loads the YAML properties from the given
URL . |
YamlPropertiesBuilder(Map<?,?> aProperties) |
Create a
YamlPropertiesBuilder instance containing the
elements of the provided Map instance using the default path
delimiter "/" (Delimiter.PATH ) for the path declarations |
YamlPropertiesBuilder(Properties aProperties) |
Create a
YamlPropertiesBuilder instance containing the
elements of the provided Properties instance using the default
path delimiter "/" (Delimiter.PATH ) for the path declarations |
YamlPropertiesBuilder(Properties.PropertiesBuilder aProperties) |
Create a
YamlPropertiesBuilder instance containing the
elements of the provided Properties.PropertiesBuilder instance using the
default path delimiter "/" (Delimiter.PATH ) for the path
declarations |
Modifier and Type | Method | Description |
---|---|---|
Properties |
loadFrom(InputStream aInputStream,
char... aDelimiters) |
Loads the properties from the given
InputStream . |
void |
saveTo(OutputStream aOutputStream,
String aComment,
char aDelimiter) |
The comment is ignored for the YAML format as YAML does not(!)
|
equals, hashCode, toString
flush, isFlushable, loadFrom, reload, reload, saveTo, seekFrom
toInstance, toInstance, toType, toType
withInsert, withInsert, withInsertFrom, withInsertTo
insert, insert, insertFrom, insertTo, putAll, toDump, toSourceCode, toSourceCode
withFlush, withFlushUnchecked
clear, clone, containsValue, entrySet, forEach, isEmpty, keySet, putAll, replaceAll, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath
insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, removeAll
withInsert, withInsert, withInsertFrom, withInsertTo
compute, computeIfAbsent, computeIfPresent, containsKey, get, getDelimiter, getOrDefault, getType, merge, put, putIfAbsent, remove, remove, replace, replace, toDataStructure
childrenOf, getDelimiter, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath
containsValue, delete, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll
withInsert, withInsert, withInsertFrom, withInsertTo
containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort
withPut
put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort
childrenOf, retrieveFrom, retrieveTo
reload, reload
fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, flush, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, parseFrom, parseFrom, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, toSerialized, toSerialized
withInsert, withInsert, withInsertFrom, withInsertTo, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withLoadFrom, withPut, withPut, withPutBoolean, withPutByte, withPutDouble, withPutFloat, withPutInteger, withPutLong, withPutShort, withRemoveFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom, withSeekFrom
public static final char COMMENT
public YamlPropertiesBuilder()
YamlPropertiesBuilder
instance using the
default path delimiter "/" (Delimiter.PATH
) for the path
declarations.public YamlPropertiesBuilder(Object aObj)
YamlPropertiesBuilder
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."aObj
- The object from which the elements are to be added.public YamlPropertiesBuilder(Properties aProperties)
YamlPropertiesBuilder
instance containing the
elements of the provided Properties
instance using the default
path delimiter "/" (Delimiter.PATH
) for the path declarationsaProperties
- the properties to be added.public YamlPropertiesBuilder(Properties.PropertiesBuilder aProperties)
YamlPropertiesBuilder
instance containing the
elements of the provided Properties.PropertiesBuilder
instance using the
default path delimiter "/" (Delimiter.PATH
) for the path
declarationsaProperties
- the properties to be added.public YamlPropertiesBuilder(Map<?,?> aProperties)
YamlPropertiesBuilder
instance containing the
elements of the provided Map
instance using the default path
delimiter "/" (Delimiter.PATH
) for the path declarationsaProperties
- the properties to be added.public YamlPropertiesBuilder(File aFile) throws IOException, ParseException
File
.aFile
- The File
from which to load the properties.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.public YamlPropertiesBuilder(File aFile, char... aDelimiters) throws IOException, ParseException
File
.aFile
- The File
from which to load the properties.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public YamlPropertiesBuilder(File aFile, boolean isSeekFile) throws IOException, ParseException
File
.
In case you enable the "seek" argument and directly loading from the
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.aFile
- The File
from which to load the properties.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.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.public YamlPropertiesBuilder(File aFile, boolean isSeekFile, char... aDelimiters) throws IOException, ParseException
File
.
In case you enable the "seek" argument and directly loading from the
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.aFile
- The File
from which to load the properties.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public YamlPropertiesBuilder(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.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.public YamlPropertiesBuilder(String aFilePath, char... aDelimiters) throws IOException, ParseException
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.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.public YamlPropertiesBuilder(Class<?> aResourceClass, String aFilePath) throws IOException, ParseException
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.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.public YamlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, char... aDelimiters) throws IOException, ParseException
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.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.public YamlPropertiesBuilder(String aFilePath, boolean isSeekFile) throws IOException, ParseException
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.aFilePath
- The path to the file from which to load the properties.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.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.public YamlPropertiesBuilder(String aFilePath, boolean isSeekFile, char... aDelimiters) throws IOException, ParseException
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.aFilePath
- The path to the file from which to load the properties.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public YamlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, boolean isSeekFile) throws IOException, ParseException
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.
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).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.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.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.public YamlPropertiesBuilder(Class<?> aResourceClass, String aFilePath, boolean isSeekFile, char... aDelimiters) throws IOException, ParseException
File
does not succeed, then loads from the first folder
containing such a file as of the specification for the method
RuntimeUtility.toConfigDirs()
.
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). *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.isSeekFile
- When true, then the properties are loaded as of the
"seek" functionality described above.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public YamlPropertiesBuilder(URL aUrl) throws IOException, ParseException
URL
.aUrl
- The URL
from which to read the properties.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.public YamlPropertiesBuilder(URL aUrl, char... aDelimiters) throws IOException, ParseException
URL
.aUrl
- The URL
from which to read the properties.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public YamlPropertiesBuilder(InputStream aInputStream) throws IOException, ParseException
InputStream
.aInputStream
- The InputStream
from which to read the
properties.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.public YamlPropertiesBuilder(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException
InputStream
.aInputStream
- The InputStream
from which to read the
properties.aDelimiters
- The path delimiters to be used when parsing the
source's properties.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.public Properties loadFrom(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException
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.loadFrom
in interface ResourceProperties.MutableResoureProperties
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).Properties
as loaded from the resource and
applied to this instance.IOException
- thrown in case loading the properties failedParseException
- Signals that an error has been reached
unexpectedly while parsing the data to be loaded.public void saveTo(OutputStream aOutputStream, String aComment, char aDelimiter) throws IOException
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.saveTo
in interface ResourceProperties.MutableResoureProperties
aOutputStream
- The OutputStream
to which to save the
properties to.aComment
- The description for the properties file.aDelimiter
- The path delimiter to be used when writing out the
properties to the destination (in case the the serialized
format supports / requires the such).IOException
- thrown in case saving the properties failedCopyright © 2018. All rights reserved.