Interface ResourcePropertiesFactory

All Superinterfaces:

FilenameSuffixesAccessor, ImmutableResourcePropertiesFactory

All Known Implementing Classes:

JavaPropertiesFactory, JsonPropertiesFactory, PolyglotProperties.PolyglotPropertiesFactory, TomlPropertiesFactory, XmlPropertiesFactory, YamlPropertiesFactory

public interface ResourcePropertiesFactory
extends ImmutableResourcePropertiesFactory

Factory interface for creating ResourceProperties instances.

Nested Class Summary

Nested classes/interfaces inherited from interface FilenameSuffixesAccessor

FilenameSuffixesAccessor.FilenameSuffixesBuilder<B>, FilenameSuffixesAccessor.FilenameSuffixesMutator, FilenameSuffixesAccessor.FilenameSuffixesProperty

Method Summary

Modifier and Type	Method	Description
default ResourceProperties	toProperties(File aFile)	Loads the properties from the given File.
ResourceProperties	toProperties(File aFile, ConfigLocator aConfigLocator)	Loads or seeks the properties from the given File.
ResourceProperties	toProperties(InputStream aInputStream)	Reads the properties from the given InputStream.
default ResourceProperties	toProperties(Class<?> aResourceClass, String aFilePath)	Loads the properties from the given file's path.
ResourceProperties	toProperties(Class<?> aResourceClass, String aFilePath, ConfigLocator aConfigLocator)	Loads the properties from the given file's path.
ResourceProperties	toProperties(Object aObj)	Create a ImmutableResourceProperties instance containing the elements as of ImmutablePathTable.MutablePathTable.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.
default ResourceProperties	toProperties(String aFilePath)	Loads the properties from the given file's path.
default ResourceProperties	toProperties(String aFilePath, ConfigLocator aConfigLocator)	Loads the properties from the given file's path.
ResourceProperties	toProperties(URL aUrl)	Loads the properties from the given URL.
ResourceProperties	toProperties(Map<?,?> aProperties)	Create a ImmutableResourceProperties instance containing the elements of the provided Map instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.
ResourceProperties	toProperties(ImmutableProperties aProperties)	Create a ImmutableResourceProperties instance containing the elements of the provided ImmutableProperties instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.
ResourceProperties	toProperties(Properties aProperties)	Create a ImmutableResourceProperties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Methods inherited from interface FilenameSuffixesAccessor

getFilenameSuffixes

Methods inherited from interface ImmutableResourcePropertiesFactory

hasFilenameSuffix, hasFilenameSuffix

Method Details

toProperties

default ResourceProperties toProperties(Class<?> aResourceClass,
 String aFilePath)
                                 throws IOException,
ParseException

Loads the properties from the given file's path.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

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 accordingly constructed ImmutableResourceProperties.

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

ResourceProperties toProperties(Class<?> aResourceClass,
 String aFilePath,
 ConfigLocator aConfigLocator)
                         throws IOException,
ParseException

Loads the 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).

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

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.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

default ResourceProperties toProperties(File aFile)
                                 throws IOException,
ParseException

Loads the properties from the given File.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aFile - The File from which to load the properties.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

ResourceProperties toProperties(File aFile,
 ConfigLocator aConfigLocator)
                         throws IOException,
ParseException

Loads or seeks the properties from the given File. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aFile - The File from which to load the properties.

aConfigLocator - The ConfigLocator describes the locations to additional crawl for the desired file.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

ResourceProperties toProperties(InputStream aInputStream)
                         throws IOException,
ParseException

Reads the properties from the given InputStream.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aInputStream - The InputStream from which to read the properties.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

ResourceProperties toProperties(Map<?,?> aProperties)

Create a ImmutableResourceProperties instance containing the elements of the provided Map instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

ResourceProperties toProperties(Object aObj)

Create a ImmutableResourceProperties instance containing the elements as of ImmutablePathTable.MutablePathTable.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 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."

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aObj - The object from which the elements are to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

ResourceProperties toProperties(ImmutableProperties aProperties)

Create a ImmutableResourceProperties instance containing the elements of the provided ImmutableProperties instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

ResourceProperties toProperties(Properties aProperties)

Create a ImmutableResourceProperties instance containing the elements of the provided Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

default ResourceProperties toProperties(String aFilePath)
                                 throws IOException,
ParseException

Loads the properties from the given file's path.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aFilePath - The path to the file from which to load the properties.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

default ResourceProperties toProperties(String aFilePath,
 ConfigLocator aConfigLocator)
                                 throws IOException,
ParseException

Loads the properties from the given file's path. A provided ConfigLocator describes the locations to additional crawl for the desired file.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

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.

Returns:

The accordingly constructed ImmutableResourceProperties.

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

ResourceProperties toProperties(URL aUrl)
                         throws IOException,
ParseException

Loads the properties from the given URL.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Parameters:

aUrl - The URL from which to read the properties.

Returns:

The accordingly constructed ImmutableResourceProperties.

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.