Module org.refcodes.properties
Package org.refcodes.properties

Class YamlProperties

  • All Implemented Interfaces:
    org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<String>, Properties, ResourceProperties, org.refcodes.struct.CanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.Dictionary<String,​String>, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,​String>, org.refcodes.struct.PathMap<String>
    public class YamlProperties
extends AbstractResourceProperties
implements ResourceProperties
    Implementation of the ResourceProperties interface with support of so called "YAML properties". For YAML properties, see "https://en.wikipedia.org/wiki/YAML"

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  YamlProperties.YamlPropertiesFactory
      The YamlProperties.YamlPropertiesFactory represents a ResourcePropertiesFactory creating instances of type YamlProperties.

      • 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.mixin.EmptyAccessor

        org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

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

    • Constructor Summary

      Constructors 
      Constructor Description
      YamlProperties​(File aFile)
      Loads the YAML Properties from the given File.
      YamlProperties​(File aFile, char... aDelimiters)
      Loads the YAML Properties from the given File.
      YamlProperties​(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)
      Loads or seeks the YAML Properties from the given File.
      YamlProperties​(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      Loads or seeks the YAML Properties from the given File.
      YamlProperties​(InputStream aInputStream)
      Reads the YAML Properties from the given InputStream.
      YamlProperties​(InputStream aInputStream, char... aDelimiters)
      Reads the YAML Properties from the given InputStream.
      YamlProperties​(Class<?> aResourceClass, String aFilePath)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(Class<?> aResourceClass, String aFilePath, char... aDelimiters)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(Object aObj)
      Create a YamlProperties instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object.
      YamlProperties​(String aFilePath)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(String aFilePath, char... aDelimiters)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
      Loads the YAML Properties from the given file's path.
      YamlProperties​(URL aUrl)
      Loads the YAML Properties from the given URL.
      YamlProperties​(URL aUrl, char... aDelimiters)
      Loads the YAML Properties from the given URL.
      YamlProperties​(Map<?,​?> aProperties)
      Create a YamlProperties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
      YamlProperties​(Properties aProperties)
      Create a YamlProperties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
      YamlProperties​(Properties.PropertiesBuilder aProperties)
      Create a YamlProperties instance containing the elements of the provided Properties.PropertiesBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean containsKey​(Object aKey)
      String get​(Object aKey)
      char getDelimiter()
      Returns the default path delimiter as of Delimiter.PATH.
      Class<String> getType()
      boolean isEmpty()
      Set<String> keySet()
      Properties reload()
      Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
      Properties reload​(ReloadMode aReloadMode)
      Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
      Properties retrieveFrom​(String aFromPath)
      Properties retrieveTo​(String aToPath)
      int size()
      Object toDataStructure​(String aFromPath)
      Collection<String> values()

      • 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.mixin.Dumpable

        toDump, toDump, toPrintable

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

        getOr, use

      • 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, 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, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

    • Constructor Detail

      • YamlProperties

        public YamlProperties​(Object aObj)
        Create a YamlProperties instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object. Elements of type Map, Collection and arrays are identified and handled as of their type: The path for each value in a Map is appended with its according key. The path for each value in a Collection or array is appended with its according index of occurrence (in case of a List or an array, its actual index). In case of reflection, the path for each member is appended with its according mamber's name. All elements (e.g. the members and values) are inspected recursively which results in the according paths of the terminating values."
        Parameters:
        aObj - The object from which the elements are to be added.

      • YamlProperties

        public YamlProperties​(Properties aProperties)
        Create a YamlProperties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
        Parameters:
        aProperties - the properties to be added.

      • YamlProperties

        public YamlProperties​(Map<?,​?> aProperties)
        Create a YamlProperties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations
        Parameters:
        aProperties - the properties to be added.

      • YamlProperties

        public YamlProperties​(File aFile)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given File.
        Parameters:
        aFile - The File from which to load the properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(File aFile,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given File.
        Parameters:
        aFile - The File from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(File aFile,
                      org.refcodes.runtime.ConfigLocator aConfigLocator)
               throws IOException,
                      ParseException
        Loads or seeks the YAML Properties from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.
        Parameters:
        aFile - The File from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(File aFile,
                      org.refcodes.runtime.ConfigLocator aConfigLocator,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads or seeks the YAML Properties from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.
        Parameters:
        aFile - The File 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.
        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.

      • YamlProperties

        public YamlProperties​(String aFilePath)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path.
        Parameters:
        aFilePath - The path to the file from which to load the properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(String aFilePath,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path.
        Parameters:
        aFilePath - The path to the file from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(Class<?> aResourceClass,
                      String aFilePath)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(Class<?> aResourceClass,
                      String aFilePath,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(String aFilePath,
                      org.refcodes.runtime.ConfigLocator aConfigLocator)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.
        Parameters:
        aFilePath - The path to the file from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(String aFilePath,
                      org.refcodes.runtime.ConfigLocator aConfigLocator,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.
        Parameters:
        aFilePath - The path to the file 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.
        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.

      • YamlProperties

        public YamlProperties​(Class<?> aResourceClass,
                      String aFilePath,
                      org.refcodes.runtime.ConfigLocator aConfigLocator)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        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.

      • YamlProperties

        public YamlProperties​(Class<?> aResourceClass,
                      String aFilePath,
                      org.refcodes.runtime.ConfigLocator aConfigLocator,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file. Finally (if nothing else succeeds) the properties are loaded by the provided class's class loader which takes care of loading the properties (in case the file path is a relative path, also the absolute path with a prefixed path delimiter "/" is probed).
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The file path of the class's resources from which to load the properties.
        aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        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.

      • YamlProperties

        public YamlProperties​(URL aUrl)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given URL.
        Parameters:
        aUrl - The URL from which to read the properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(URL aUrl,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Loads the YAML Properties from the given URL.
        Parameters:
        aUrl - The URL from which to read the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(InputStream aInputStream)
               throws IOException,
                      ParseException
        Reads the YAML Properties from the given InputStream.
        Parameters:
        aInputStream - The InputStream from which to read the properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

      • YamlProperties

        public YamlProperties​(InputStream aInputStream,
                      char... aDelimiters)
               throws IOException,
                      ParseException
        Reads the YAML Properties from the given InputStream.
        Parameters:
        aInputStream - The InputStream from which to read the properties.
        aDelimiters - The path delimiters to be used when parsing the source's properties.
        Throws:
        IOException - thrown in case accessing or processing the properties file failed.
        ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.