Package org.refcodes.configuration

Interface ResourceProperties.MutableResoureProperties

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

        org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.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.structure.Dictionary

        org.refcodes.structure.Dictionary.MutableDictionary<K extends java.lang.Object,V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary

        org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends java.lang.Object,V extends java.lang.Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

      • 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.structure.Keys

        org.refcodes.structure.Keys.MutableKeys<K extends java.lang.Object,V extends java.lang.Object>, org.refcodes.structure.Keys.MutableValues<K extends java.lang.Object,V extends java.lang.Object>

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

        java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

        org.refcodes.structure.PathMap.MutablePathMap<T extends java.lang.Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends java.lang.Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

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

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.io.File fileTo​(java.io.File aFile)
      Files (writes) the properties to the given File.
      default java.io.File fileTo​(java.io.File aFile, char aDelimiter)
      Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter.
      default java.io.File fileTo​(java.io.File aFile, java.lang.String aComment)
      Files (writes) the properties to the given File.
      default java.io.File fileTo​(java.io.File aFile, java.lang.String aComment, char aDelimiter)
      Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter.
      default java.io.File fileTo​(java.lang.String aFilePath)
      Files (writes) the properties to the given File.
      default java.io.File fileTo​(java.lang.String aFilePath, char aDelimiter)
      Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter.
      default java.io.File fileTo​(java.lang.String aFilePath, java.lang.String aComment)
      Files (writes) the properties to the File represented by the given file path.
      default java.io.File fileTo​(java.lang.String aFilePath, java.lang.String aComment, char aDelimiter)
      Files (writes) the properties to the File represented by the given file path using the provided delimiter as the destination's path delimiter.
      void flush​()
      Flushes ResourceProperties.MutableResoureProperties to the resource to which the ResourceProperties are attached to (such as a File as of loadFrom(File) or saveTo(File)).
      default Properties loadFrom​(java.io.File aFile)
      Loads the properties from the given File.
      Properties loadFrom​(java.io.File aFile, char... aDelimiters)
      Loads the properties from the given File.
      default Properties loadFrom​(java.io.InputStream aInputStream)
      Loads the properties from the given InputStream.
      Properties loadFrom​(java.io.InputStream aInputStream, char... aDelimiters)
      Loads the properties from the given InputStream.
      default Properties loadFrom​(java.lang.Class<?> aResourceClass, java.lang.String aFilePath)
      Loads the properties from the given class resource (from inside a JAR).
      default Properties loadFrom​(java.lang.Class<?> aResourceClass, java.lang.String aFilePath, char... aDelimiters)
      Loads the properties from the given class resource (from inside a JAR).
      default Properties loadFrom​(java.lang.String aFilePath)
      Loads the properties from the given file path's File.
      default Properties loadFrom​(java.lang.String aFilePath, char... aDelimiters)
      Loads the properties from the given file path's File.
      default Properties loadFrom​(java.net.URL aUrl)
      Loads the properties from the given URL.
      default Properties loadFrom​(java.net.URL aUrl, char... aDelimiters)
      Loads the properties from the given URL.
      default void parseFrom​(java.lang.String aSerialized)
      Inspects the given serialized representation and adds all declared elements found.
      default void parseFrom​(java.lang.String aSerialized, char... aDelimiters)
      Inspects the given serialized representation and adds all declared elements found.
      default java.io.File saveTo​(java.io.File aFile)
      Saves the properties to the given File.
      default java.io.File saveTo​(java.io.File aFile, char aDelimiter)
      Saves the properties to the given File using the provided delimiter as the destination's path delimiter.
      default java.io.File saveTo​(java.io.File aFile, java.lang.String aComment)
      Saves the properties to the given File.
      java.io.File saveTo​(java.io.File aFile, java.lang.String aComment, char aDelimiter)
      Saves the properties to the given File using the provided delimiter as the destination's path delimiter.
      default void saveTo​(java.io.OutputStream aOutputStream)
      Saves the properties to the given OutputStream.
      default void saveTo​(java.io.OutputStream aOutputStream, char aDelimiter)
      Saves the properties to the given OutputStream.
      default void saveTo​(java.io.OutputStream aOutputStream, java.lang.String aComment)
      Saves the properties to the given OutputStream.
      void saveTo​(java.io.OutputStream aOutputStream, java.lang.String aComment, char aDelimiter)
      Saves the properties to the given OutputStream using the provided delimiter as the destination's path delimiter.
      default java.io.File saveTo​(java.lang.String aFilePath)
      Saves the properties to the given File.
      default java.io.File saveTo​(java.lang.String aFilePath, char aDelimiter)
      Saves the properties to the given File using the provided delimiter as the destination's path delimiter.
      default java.io.File saveTo​(java.lang.String aFilePath, java.lang.String aComment)
      Saves the properties to the File represented by the given file path.
      default java.io.File saveTo​(java.lang.String aFilePath, java.lang.String aComment, char aDelimiter)
      Saves the properties to the File represented by the given file path using the provided delimiter as the destination's path delimiter.
      default Properties seekFrom​(java.io.File aFile)
      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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.io.File aFile, char... aDelimiters)
      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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.io.File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.lang.Class<?> aResourceClass, java.lang.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.lang.Class<?> aResourceClass, java.lang.String aFilePath, char... aDelimiters)
      Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator.ALL configuration.
      Properties seekFrom​(java.lang.Class<?> aResourceClass, java.lang.String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator configuration passed.
      default Properties seekFrom​(java.lang.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.lang.String aFilePath, char... aDelimiters)
      Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the specification for the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default Properties seekFrom​(java.lang.String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the specification for the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed).
      default java.lang.String toSerialized​(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.structure.CanonicalMap

        toInstance, toInstance, toType, toType

      • Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

        insert, insert, insertFrom, insertTo, putAll, toDump, toSourceCode, toSourceCode

      • Methods inherited from interface org.refcodes.structure.Clearable

        clear

      • Methods inherited from interface org.refcodes.structure.Containable

        isEmpty, size

      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump

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

        flushUnchecked, isFlushable

      • Methods inherited from interface org.refcodes.structure.Keys

        containsKey, get, keySet, use, values

      • Methods inherited from interface org.refcodes.structure.Keys.MutableValues

        put

      • Methods inherited from interface java.util.Map

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

      • Methods inherited from interface org.refcodes.structure.PathMap

        children, children, children, directories, directories, directories, directories, directories, fromExternalKey, get, get, getArray, getArray, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getIndexes, getIndexes, getInteger, getInteger, getLong, getLong, getRootPath, getShort, getShort, hasChildren, hasChildren, hasChildren, hasIndexed, hasIndexed, hasParentPath, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isDirectory, isDirectory, isDirectory, isDirectory, isIndexed, isIndexed, isPath, isRecord, isRecord, isRecord, isRecord, isRootPath, keySet, paths, paths, paths, paths, paths, queryPaths, records, records, records, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toPath

      • Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

        insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, remove, remove, removeAll, removeAll, removeFrom, removeFrom, removeFrom, removeFrom

      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        asArray, asArray, asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asLongArray, asLongArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, asShortArray, asShortArray, containsKey, get, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getShort, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

        put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

    • Field Detail

      • DEFAULT_COMMENT

        static final java.lang.String DEFAULT_COMMENT

    • Method Detail

      • toSerialized

        default java.lang.String toSerialized​(char aDelimiter)
        Produces the external representation of the properties as of the serialized format supported by the implementing class.
        Specified by:
        toSerialized in interface ResourceProperties
        Parameters:
        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.

      • saveTo

        default java.io.File saveTo​(java.lang.String aFilePath)
                     throws java.io.IOException
        Saves the properties to the given File. Load them via loadFrom(File) The default implementation uses the hook method saveTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.lang.String aFilePath,
                            char aDelimiter)
                     throws java.io.IOException
        Saves the properties to the given File using the provided delimiter as the destination's path delimiter. Load them via loadFrom(String, char...) The default implementation uses the hook method saveTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.io.File aFile)
                     throws java.io.IOException
        Saves the properties to the given File. Load them via loadFrom(File). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File from which to load the properties.
        Returns:
        The File representing the actual location where the properties have been saved to.
        Throws:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.io.File aFile,
                            char aDelimiter)
                     throws java.io.IOException
        Saves the properties to the given File using the provided delimiter as the destination's path delimiter. Load them via loadFrom(File, char...). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.lang.String aFilePath,
                            java.lang.String aComment)
                     throws java.io.IOException
        Saves the properties to the File represented by the given file path. Load them via loadFrom(String). The default implementation uses the hook method saveTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.lang.String aFilePath,
                            java.lang.String aComment,
                            char aDelimiter)
                     throws java.io.IOException
        Saves the properties to the File represented by the given file path using the provided delimiter as the destination's path delimiter. Load them via loadFrom(File, char...). The default implementation uses the hook method saveTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default java.io.File saveTo​(java.io.File aFile,
                            java.lang.String aComment)
                     throws java.io.IOException
        Saves the properties to the given File. Load them via loadFrom(File). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        java.io.File saveTo​(java.io.File aFile,
                    java.lang.String aComment,
                    char aDelimiter)
             throws java.io.IOException
        Saves the properties to the given File using the provided delimiter as the destination's path delimiter. Load them via loadFrom(File, char...). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default void saveTo​(java.io.OutputStream aOutputStream)
             throws java.io.IOException
        Saves the properties to the given OutputStream. Load them via loadFrom(InputStream). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aOutputStream - the output stream
        Throws:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default void saveTo​(java.io.OutputStream aOutputStream,
                    char aDelimiter)
             throws java.io.IOException
        Saves the properties to the given OutputStream. Load them via loadFrom(InputStream, char...). The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aOutputStream - the OutputStream 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:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        default void saveTo​(java.io.OutputStream aOutputStream,
                    java.lang.String aComment)
             throws java.io.IOException
        Saves the properties to the given OutputStream. Load them via loadFrom(InputStream) The default implementation uses the hook method saveTo(OutputStream, String, char) to finally format and write the properties.
        Parameters:
        aOutputStream - The OutputStream to which to save the properties to.
        aComment - The description for the properties file.
        Throws:
        java.io.IOException - thrown in case saving the properties failed

      • saveTo

        void saveTo​(java.io.OutputStream aOutputStream,
            java.lang.String aComment,
            char aDelimiter)
     throws java.io.IOException
        Saves the properties to the given OutputStream using the provided delimiter as the destination's path delimiter. Load them via 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.
        Parameters:
        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).
        Throws:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.lang.String aFilePath)
                     throws java.io.IOException
        Files (writes) the properties to the given File. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(File) The default implementation uses the hook method fileTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.lang.String aFilePath,
                            char aDelimiter)
                     throws java.io.IOException
        Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(String, char...) The default implementation uses the hook method fileTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.io.File aFile)
                     throws java.io.IOException
        Files (writes) the properties to the given File. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(File). The default implementation uses the hook method fileTo(File, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File from which to load the properties.
        Returns:
        The File representing the actual location where the properties have been saved to.
        Throws:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.io.File aFile,
                            char aDelimiter)
                     throws java.io.IOException
        Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(File, char...). The default implementation uses the hook method fileTo(File, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.lang.String aFilePath,
                            java.lang.String aComment)
                     throws java.io.IOException
        Files (writes) the properties to the File represented by the given file path. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(String). The default implementation uses the hook method fileTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.lang.String aFilePath,
                            java.lang.String aComment,
                            char aDelimiter)
                     throws java.io.IOException
        Files (writes) the properties to the File 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 method ConfigLocator.getFolders(File...). Load them via seekFrom(File, char...). The default implementation uses the hook method fileTo(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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.io.File aFile,
                            java.lang.String aComment)
                     throws java.io.IOException
        Files (writes) the properties to the given File. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(File). The default implementation uses the hook method fileTo(File, String, char) to finally format and write the properties.
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • fileTo

        default java.io.File fileTo​(java.io.File aFile,
                            java.lang.String aComment,
                            char aDelimiter)
                     throws java.io.IOException
        Files (writes) the properties to the given File using the provided delimiter as the destination's path delimiter. The properties are filed to the first folder detected by the method ConfigLocator.getFolders(File...). Load them via seekFrom(File, char...).
        Parameters:
        aFile - The File 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:
        java.io.IOException - thrown in case saving the properties failed

      • loadFrom

        default Properties loadFrom​(java.lang.String aFilePath)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given file path's File. Save them using the method saveTo(String). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFilePath - The file path from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded..

      • loadFrom

        default Properties loadFrom​(java.lang.Class<?> aResourceClass,
                            java.lang.String aFilePath)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given class resource (from inside a JAR). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.lang.String aFilePath,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given file path's File. Save them using the method saveTo(String, char). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFilePath - The file path from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.lang.Class<?> aResourceClass,
                            java.lang.String aFilePath,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given class resource (from inside a JAR). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.io.File aFile)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given File. Save them using the method saveTo(File). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFile - The File from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        Properties loadFrom​(java.io.File aFile,
                    char... aDelimiters)
             throws java.io.IOException,
                    java.text.ParseException
        Loads the properties from the given File. Save them using the method saveTo(File). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFile - The File from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.net.URL aUrl)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given URL. The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aUrl - The URL from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.net.URL aUrl,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given URL. The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aUrl - The URL from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        default Properties loadFrom​(java.io.InputStream aInputStream)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads the properties from the given InputStream. Save them using the method saveTo(OutputStream). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aInputStream - The InputStream from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • loadFrom

        Properties loadFrom​(java.io.InputStream aInputStream,
                    char... aDelimiters)
             throws java.io.IOException,
                    java.text.ParseException
        Loads the properties from the given InputStream. Save them using the method 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.
        Parameters:
        aInputStream - The InputStream from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case loading the properties failed
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • parseFrom

        default void parseFrom​(java.lang.String aSerialized)
                throws java.text.ParseException
        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 loadFrom(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:
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • parseFrom

        default void parseFrom​(java.lang.String aSerialized,
                       char... aDelimiters)
                throws java.text.ParseException
        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 loadFrom(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:
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.io.File aFile)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(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:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.io.File aFile,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(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:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.io.File aFile,
                            org.refcodes.runtime.ConfigLocator aConfigLocator,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFile - The file of the properties file to load.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.lang.String aFilePath)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFilePath - The file path from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.lang.Class<?> aResourceClass,
                            java.lang.String aFilePath)
                     throws java.io.IOException,
                            java.text.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 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 loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path from which to load the properties.
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.lang.String aFilePath,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFilePath - The file path from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.lang.String aFilePath,
                            org.refcodes.runtime.ConfigLocator aConfigLocator,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.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 the ConfigLocator (if not provided, then ConfigLocator.ALL is assumed). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aFilePath - The file path from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        default Properties seekFrom​(java.lang.Class<?> aResourceClass,
                            java.lang.String aFilePath,
                            char... aDelimiters)
                     throws java.io.IOException,
                            java.text.ParseException
        Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator.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 method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path 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:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • seekFrom

        Properties seekFrom​(java.lang.Class<?> aResourceClass,
                    java.lang.String aFilePath,
                    org.refcodes.runtime.ConfigLocator aConfigLocator,
                    char... aDelimiters)
             throws java.io.IOException,
                    java.text.ParseException
        Loads a properties file from the file path directly or (if not found) from the first folder containing such a file as of the ConfigLocator configuration passed. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed). The default implementation uses the hook method loadFrom(InputStream, char...) to finally load and parse the properties.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        aDelimiters - The path delimiters to be used when parsing the source's properties (in case the the serialized format supports / requires the such).
        Returns:
        The Properties as loaded from the resource and applied to this instance.
        Throws:
        java.io.IOException - thrown in case accessing or processing the properties file failed.
        java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.