Module org.refcodes.properties
Package org.refcodes.properties
Interface ResourceProperties.MutableResoureProperties
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,org.refcodes.struct.CanonicalMap
,org.refcodes.struct.CanonicalMap.MutableCanonicalMap
,org.refcodes.mixin.Clearable
,org.refcodes.struct.Containable
,org.refcodes.mixin.DelimiterAccessor
,org.refcodes.struct.Dictionary<String,
,String> org.refcodes.struct.Dictionary.MutableDictionary<String,
,String> org.refcodes.mixin.Dumpable
,org.refcodes.mixin.EmptyAccessor
,Flushable
,org.refcodes.component.Flushable
,org.refcodes.struct.InterOperableMap<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> Map<String,
,String> org.refcodes.struct.PathMap<String>
,org.refcodes.struct.PathMap.MutablePathMap<String>
,Properties
,Properties.MutableProperties
,ResourceProperties
,org.refcodes.mixin.TypeAccessor<String>
- All Known Subinterfaces:
ResourceProperties.ResourcePropertiesBuilder
,ScheduledResourceProperties.ScheduledMuableResourceProperties
,ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
- All Known Implementing Classes:
AbstractResourcePropertiesBuilder
,AbstractResourcePropertiesBuilderDecorator
,JavaPropertiesBuilder
,JsonPropertiesBuilder
,PolyglotPropertiesBuilder
,ScheduledResourcePropertiesBuilderDecorator
,TomlPropertiesBuilder
,XmlPropertiesBuilder
,YamlPropertiesBuilder
- Enclosing interface:
- ResourceProperties
public static interface ResourceProperties.MutableResoureProperties
extends ResourceProperties, Properties.MutableProperties, org.refcodes.component.Flushable
The interface
ResourceProperties.MutableResoureProperties
defines "dirty" methods
allowing to modify ("mutate") the ResourceProperties
.-
Nested Class Summary
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 inherited from interface org.refcodes.struct.PathMap
ANNOTATOR, DELIMITER
-
Method Summary
Modifier and TypeMethodDescriptiondefault File
Files (writes) the properties to the givenFile
.default File
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default File
Files (writes) the properties to the givenFile
.default File
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default File
Files (writes) the properties to the givenFile
.default File
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default File
Files (writes) the properties to theFile
represented by the given file path.default File
Files (writes) the properties to theFile
represented by the given file path using the provided delimiter as the destination's path delimiter.void
flush()
FlushesResourceProperties.MutableResoureProperties
to the resource to which theResourceProperties
are attached to (such as aFile
as ofloadFrom(File)
orsaveTo(File)
).default Properties
Loads the properties from the givenFile
.Loads the properties from the givenFile
.default Properties
loadFrom
(InputStream aInputStream) Loads the properties from the givenInputStream
.loadFrom
(InputStream aInputStream, char... aDelimiters) Loads the properties from the givenInputStream
.default Properties
Loads the properties from the given class resource (from inside a JAR).default Properties
Loads the properties from the given class resource (from inside a JAR).default Properties
Loads the properties from the given file path'sFile
.default Properties
Loads the properties from the given file path'sFile
.default Properties
Loads the properties from the givenURL
.default Properties
Loads the properties from the givenURL
.default void
Inspects the given serialized representation and adds all declared elements found.default void
Inspects the given serialized representation and adds all declared elements found.default File
Saves the properties to the givenFile
.default File
Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default File
Saves the properties to the givenFile
.Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default void
saveTo
(OutputStream aOutputStream) Saves the properties to the givenOutputStream
.default void
saveTo
(OutputStream aOutputStream, char aDelimiter) Saves the properties to the givenOutputStream
.default void
saveTo
(OutputStream aOutputStream, String aComment) Saves the properties to the givenOutputStream
.void
saveTo
(OutputStream aOutputStream, String aComment, char aDelimiter) Saves the properties to the givenOutputStream
using the provided delimiter as the destination's path delimiter.default File
Saves the properties to the givenFile
.default File
Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter.default File
Saves the properties to theFile
represented by the given file path.default File
Saves the properties to theFile
represented by the given file path using the provided delimiter as the destination's path delimiter.default Properties
Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed).default Properties
Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed).default Properties
Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed).default Properties
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).default Properties
Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of theConfigLocator.ALL
configuration.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 theConfigLocator
configuration passed.default Properties
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).default Properties
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).default Properties
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).default String
toSerialized
(String aComment, char aDelimiter) Produces the external representation of the properties as of the serialized format supported by the implementing class.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
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, isFlushable
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
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, 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, 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, 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
-
Field Details
-
DEFAULT_COMMENT
-
-
Method Details
-
fileTo
Files (writes) the properties to the givenFile
. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File)
. The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File, char...)
. The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to the givenFile
. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File)
. The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File, char...)
.- Parameters:
aFile
- TheFile
to which to file 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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to the givenFile
. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File)
The default implementation uses the hook methodfileTo(String, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to the givenFile
using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(String, char...)
The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to theFile
represented by the given file path. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(String)
. The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
fileTo
Files (writes) the properties to theFile
represented by the given file path using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the methodConfigLocator.getFolders(File...)
. Load them viaseekFrom(File, char...)
. The default implementation uses the hook methodfileTo(File, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.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).aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
flush
FlushesResourceProperties.MutableResoureProperties
to the resource to which theResourceProperties
are attached to (such as aFile
as ofloadFrom(File)
orsaveTo(File)
).- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in interfaceorg.refcodes.component.Flushable
- Throws:
IOException
-
loadFrom
default 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 methodloadFrom(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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
loadFrom
default 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 methodloadFrom(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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
loadFrom
Loads the properties from the givenFile
. Save them using the methodsaveTo(File)
. The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- 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
Loads the properties from the givenFile
. Save them using the methodsaveTo(File)
. The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aFile
- TheFile
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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
loadFrom
Loads the properties from the givenInputStream
. Save them using the methodsaveTo(OutputStream)
. The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- 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.
-
loadFrom
Properties loadFrom(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException Loads the properties from the givenInputStream
. Save them using the methodsaveTo(OutputStream)
. This is the hook-method of the default implementation for loading the properties. In case you want to implementResourceProperties
which support other notations than the properties notation (path=value
), then you overwrite this method in your implementation accordingly.- Parameters:
aInputStream
- TheInputStream
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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
loadFrom
Loads the properties from the given file path'sFile
. Save them using the methodsaveTo(String)
. The default implementation uses the hook methodloadFrom(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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded..
-
loadFrom
default Properties loadFrom(String aFilePath, char... aDelimiters) throws IOException, ParseException Loads the properties from the given file path'sFile
. Save them using the methodsaveTo(String, char)
. The default implementation uses the hook methodloadFrom(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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
loadFrom
Loads the properties from the givenURL
. The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aUrl
- TheURL
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
Loads the properties from the givenURL
. The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aUrl
- TheURL
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 failedParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
parseFrom
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 methodloadFrom(InputStream, char...)
to finally load and parse the properties.- 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.
-
parseFrom
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 methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aSerialized
- The serialized representation which is to be parsed for the therein declared elements being added with their according determined paths.aDelimiters
- The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).- Throws:
ParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
saveTo
Saves the properties to the givenFile
. Load them vialoadFrom(File)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter. Load them vialoadFrom(File, char...)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenFile
. Load them vialoadFrom(File)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter. Load them vialoadFrom(File, char...)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFile
- TheFile
from which to load the properties.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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenOutputStream
. Load them vialoadFrom(InputStream)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aOutputStream
- the output stream- Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenOutputStream
. Load them vialoadFrom(InputStream, char...)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aOutputStream
- theOutputStream
where to write the properties to.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).- Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenOutputStream
. Load them vialoadFrom(InputStream)
The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aOutputStream
- TheOutputStream
to which to save the properties to.aComment
- The description for the properties file.- Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenOutputStream
using the provided delimiter as the destination's path delimiter. Load them vialoadFrom(InputStream, char...)
This is the hook-method of the default implementation for writing (saving) the properties. In case you want to implementResourceProperties
which support other notations than the properties notation (path=value
), then you overwrite this method in your implementation accordingly.- Parameters:
aOutputStream
- TheOutputStream
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).- Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenFile
. Load them vialoadFrom(File)
The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to the givenFile
using the provided delimiter as the destination's path delimiter. Load them vialoadFrom(String, char...)
The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.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).- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to theFile
represented by the given file path. Load them vialoadFrom(String)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
saveTo
Saves the properties to theFile
represented by the given file path using the provided delimiter as the destination's path delimiter. Load them vialoadFrom(File, char...)
. The default implementation uses the hook methodsaveTo(OutputStream, String, char)
to finally format and write the properties.- Parameters:
aFilePath
- The file path from which to load the properties.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).aComment
- The description for the properties file.- Returns:
- The
File
representing the actual location where the properties have been saved to. - Throws:
IOException
- thrown in case saving the properties failed
-
seekFrom
default 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 methodloadFrom(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 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
default Properties seekFrom(Class<?> aResourceClass, String aFilePath, 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 theConfigLocator.ALL
configuration. 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 methodloadFrom(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 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 accessing or processing the properties file failed.ParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
seekFrom
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 theConfigLocator
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 methodloadFrom(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 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 (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.
-
seekFrom
Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aFile
- The file of the properties file to load.- 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
Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aFile
- The file of the properties file to load.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.
-
seekFrom
default Properties seekFrom(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aFile
- The file of the properties file to load.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 (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.
-
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 theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(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 accessing or processing the properties file failed.ParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
seekFrom
default Properties seekFrom(String aFilePath, 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 specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(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 accessing or processing the properties file failed.ParseException
- Signals that an error has been reached unexpectedly while parsing the data to be loaded.
-
seekFrom
default Properties seekFrom(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 specification for theConfigLocator
(if not provided, thenConfigLocator.ALL
is assumed). The default implementation uses the hook methodloadFrom(InputStream, char...)
to finally load and parse the properties.- Parameters:
aFilePath
- The file path 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 (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.
-
toSerialized
Produces the external representation of the properties as of the serialized format supported by the implementing class.- Specified by:
toSerialized
in interfaceResourceProperties
- Parameters:
aComment
- The comment to be used.aDelimiter
- The path delimiter to be used when serializing the properties (in case the the serialized format supports / requires the such).- Returns:
- The external (serialized) representation of the properties.
-