Package org.refcodes.configuration

Class YamlPropertiesBuilder

    • Constructor Detail

      • YamlPropertiesBuilder

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

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(Object aObj)
        Create a YamlPropertiesBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object. 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.

      • YamlPropertiesBuilder

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

      • YamlPropertiesBuilder

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

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

      • YamlPropertiesBuilder

        public YamlPropertiesBuilder​(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.

    • Method Detail

      • createCanonicalMapFactory

        protected org.refcodes.structure.ext.factory.CanonicalMapFactory createCanonicalMapFactory​()
        Abstract method to be implemented by the sub-classes returning the concrete CanonicalMapFactory responsible to fabricate the CanonicalMap instances as of the required notation.
        Specified by:
        createCanonicalMapFactory in class AbstractResourcePropertiesBuilder
        Returns:
        The CanonicalMapFactory supporting the required notation.

      • build

        public static YamlPropertiesBuilder build​()
        This is a convenience method for easily instantiating the according builder.
        Returns:
        an instance (using a default implementation) of this builder