Package org.refcodes.configuration
Class YamlPropertiesBuilder.YamlPropertiesBuilderFactory
- java.lang.Object
-
- org.refcodes.configuration.YamlPropertiesBuilder.YamlPropertiesBuilderFactory
-
- All Implemented Interfaces:
ResourcePropertiesFactory
,ResourcePropertiesFactory.ResourcePropertiesBuilderFactory
,org.refcodes.mixin.FilenameExtensionsAccessor
- Enclosing class:
- YamlPropertiesBuilder
public static class YamlPropertiesBuilder.YamlPropertiesBuilderFactory extends Object implements ResourcePropertiesFactory.ResourcePropertiesBuilderFactory
TheYamlPropertiesBuilder.YamlPropertiesBuilderFactory
represents aResourcePropertiesFactory.ResourcePropertiesBuilderFactory
creating instances of typeYamlPropertiesBuilder
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.FilenameExtensionsAccessor
org.refcodes.mixin.FilenameExtensionsAccessor.FilenameExtensionsBuilder<B extends org.refcodes.mixin.FilenameExtensionsAccessor.FilenameExtensionsBuilder<B>>, org.refcodes.mixin.FilenameExtensionsAccessor.FilenameExtensionsMutator, org.refcodes.mixin.FilenameExtensionsAccessor.FilenameExtensionsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.configuration.ResourcePropertiesFactory
ResourcePropertiesFactory.ResourcePropertiesBuilderFactory
-
-
Constructor Summary
Constructors Constructor Description YamlPropertiesBuilderFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String[]
getFilenameExtensions()
ResourceProperties.ResourcePropertiesBuilder
toProperties(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads or seeks the properties from the givenFile
.ResourceProperties.ResourcePropertiesBuilder
toProperties(InputStream aInputStream, char... aDelimiters)
Reads the properties from the givenInputStream
.ResourceProperties.ResourcePropertiesBuilder
toProperties(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads the properties from the given file's path.ResourceProperties.ResourcePropertiesBuilder
toProperties(Object aObj)
Create aResourceProperties
instance containing the elements as ofPathMap.MutablePathMap.insert(Object)
using the path delimiter "/" (Delimiter.PATH
) for the path declarations: "Inspects the given object and adds all elements found in the given object.ResourceProperties.ResourcePropertiesBuilder
toProperties(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
Loads the properties from the given file's path.ResourceProperties.ResourcePropertiesBuilder
toProperties(URL aUrl, char... aDelimiters)
Loads the properties from the givenURL
.ResourceProperties.ResourcePropertiesBuilder
toProperties(Map<?,?> aProperties)
Create aResourceProperties
instance containing the elements of the providedMap
instance using the path delimiter "/" (Delimiter.PATH
) for the path declarationsResourceProperties.ResourcePropertiesBuilder
toProperties(Properties aProperties)
Create aResourceProperties
instance containing the elements of the providedProperties
instance using the path delimiter "/" (Delimiter.PATH
) for the path declarationsResourceProperties.ResourcePropertiesBuilder
toProperties(Properties.PropertiesBuilder aProperties)
Create aResourceProperties
instance containing the elements of the providedProperties.PropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.refcodes.configuration.ResourcePropertiesFactory.ResourcePropertiesBuilderFactory
toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties, toProperties
-
-
-
-
Method Detail
-
getFilenameExtensions
public String[] getFilenameExtensions()
- Specified by:
getFilenameExtensions
in interfaceorg.refcodes.mixin.FilenameExtensionsAccessor
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads the properties from the given file's path. A providedConfigLocator
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).- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- 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
- TheConfigLocator
describes the locations to additional crawl for the desired file.aDelimiters
- The path delimiters to be used when parsing the source's properties.- Returns:
- The accordingly constructed
ResourceProperties
. - 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.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads or seeks the properties from the givenFile
. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aFile
- TheFile
from which to load the properties.aConfigLocator
- TheConfigLocator
describes the locations to additional crawl for the desired file.aDelimiters
- The path delimiters to be used when parsing the source's properties.- Returns:
- The accordingly constructed
ResourceProperties
. - 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.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException
Reads the properties from the givenInputStream
.- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aInputStream
- TheInputStream
from which to read the properties.aDelimiters
- The path delimiters to be used when parsing the source's properties.- Returns:
- The accordingly constructed
ResourceProperties
. - 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.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(Map<?,?> aProperties)
Create aResourceProperties
instance containing the elements of the providedMap
instance using the path delimiter "/" (Delimiter.PATH
) for the path declarations- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aProperties
- the properties to be added.- Returns:
- The accordingly constructed
ResourceProperties
.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(Object aObj)
Create aResourceProperties
instance containing the elements as ofPathMap.MutablePathMap.insert(Object)
using the path delimiter "/" (Delimiter.PATH
) for the path declarations: "Inspects the given object and adds all elements found in the given object. Elements of typeMap
,Collection
and arrays are identified and handled as of their type: The path for each value in aMap
is appended with its according key. The path for each value in aCollection
or array is appended with its according index of occurrence (in case of aList
or an array, its actual index). 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."- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aObj
- The object from which the elements are to be added.- Returns:
- The accordingly constructed
ResourceProperties
.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(Properties aProperties)
Create aResourceProperties
instance containing the elements of the providedProperties
instance using the path delimiter "/" (Delimiter.PATH
) for the path declarations- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aProperties
- the properties to be added.- Returns:
- The accordingly constructed
ResourceProperties
.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
Loads the properties from the given file's path. A providedConfigLocator
describes the locations to additional crawl for the desired file.- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aFilePath
- The path to the file from which to load the properties.aConfigLocator
- TheConfigLocator
describes the locations to additional crawl for the desired file.aDelimiters
- The path delimiters to be used when parsing the source's properties.- Returns:
- The accordingly constructed
ResourceProperties
. - 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.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(URL aUrl, char... aDelimiters) throws IOException, ParseException
Loads the properties from the givenURL
.- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aUrl
- TheURL
from which to read the properties.aDelimiters
- The path delimiters to be used when parsing the source's properties.- Returns:
- The accordingly constructed
ResourceProperties
. - 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.
-
toProperties
public ResourceProperties.ResourcePropertiesBuilder toProperties(Properties.PropertiesBuilder aProperties)
Create aResourceProperties
instance containing the elements of the providedProperties.PropertiesBuilder
instance using the default path delimiter "/" (Delimiter.PATH
) for the path declarations- Specified by:
toProperties
in interfaceResourcePropertiesFactory
- Specified by:
toProperties
in interfaceResourcePropertiesFactory.ResourcePropertiesBuilderFactory
- Parameters:
aProperties
- the properties to be added.- Returns:
- The accordingly constructed
ResourceProperties
.
-
-