Class JavaPropertiesFactory

java.lang.Object

org.refcodes.properties.JavaPropertiesFactory

All Implemented Interfaces:

FilenameSuffixesAccessor, ImmutableResourcePropertiesFactory, ResourcePropertiesFactory

public class JavaPropertiesFactory
extends Object
implements ResourcePropertiesFactory

The JavaPropertiesFactory represents a ResourcePropertiesFactory creating instances of type JavaProperties.

Nested Class Summary

Nested classes/interfaces inherited from interface FilenameSuffixesAccessor

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

Constructor Summary

Constructors

Constructor	Description
JavaPropertiesFactory()	Constructs an XmlCanonicalTableFactory for creating XmlProperties instances.
JavaPropertiesFactory(DocumentOptions aDocumentOptions)	Constructs an XmlCanonicalTableFactory for creating XmlProperties instances.

Method Summary

Modifier and Type	Method	Description
String[]	getFilenameSuffixes()
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.
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.
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 class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ImmutableResourcePropertiesFactory

hasFilenameSuffix, hasFilenameSuffix

Methods inherited from interface ResourcePropertiesFactory

toProperties, toProperties, toProperties

Constructor Details

JavaPropertiesFactory

public JavaPropertiesFactory()

Constructs an XmlCanonicalTableFactory for creating XmlProperties instances.

JavaPropertiesFactory

public JavaPropertiesFactory(DocumentOptions aDocumentOptions)

Constructs an XmlCanonicalTableFactory for creating XmlProperties instances.

Parameters:

aDocumentOptions - Provides various metrics which may be tweaked when marshaling or unmarshaling documents of various nations (such as INI, XML, YAML, JSON, TOML, PROPERTIES, etc.).

Method Details

getFilenameSuffixes

public String[] getFilenameSuffixes()

Specified by:

getFilenameSuffixes in interface FilenameSuffixesAccessor

toProperties

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

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

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

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

public ResourceProperties toProperties(InputStream aInputStream)
                                throws IOException,
ParseException

Reads the properties from the given InputStream.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Specified by:

toProperties in interface ResourcePropertiesFactory

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

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

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

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ImmutableResourceProperties.

toProperties

public 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

Specified by:

toProperties in interface ResourcePropertiesFactory

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

public ResourceProperties toProperties(URL aUrl)
                                throws IOException,
ParseException

Loads the properties from the given URL.

Specified by:

toProperties in interface ImmutableResourcePropertiesFactory

Specified by:

toProperties in interface ResourcePropertiesFactory

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.