Module org.refcodes.properties

Package org.refcodes.properties

Class PolyglotProperties.PolyglotPropertiesFactory

java.lang.Object

org.refcodes.properties.PolyglotProperties.PolyglotPropertiesFactory

All Implemented Interfaces:

org.refcodes.mixin.FilenameSuffixesAccessor, ResourcePropertiesFactory

Enclosing class:

PolyglotProperties

public static class PolyglotProperties.PolyglotPropertiesFactory
extends Object
implements ResourcePropertiesFactory

The PolyglotProperties.PolyglotPropertiesFactory is a meta factory using a collection of ResourcePropertiesFactory instances to deliver ResourceProperties instances. In case a properties file for a filename was not found, then the according factories filename extension (FilenameSuffixesAccessor.getFilenameSuffixes()) is append to the filename and probing is repeated. Any factory method such as toProperties(Map), toProperties(Object), toProperties(Properties) or toProperties(PropertiesBuilder) will return ResourceProperties created by the first added ResourcePropertiesFactory instance.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.FilenameSuffixesAccessor

org.refcodes.mixin.FilenameSuffixesAccessor.FilenameSuffixesBuilder<B extends org.refcodes.mixin.FilenameSuffixesAccessor.FilenameSuffixesBuilder<B>>, org.refcodes.mixin.FilenameSuffixesAccessor.FilenameSuffixesMutator, org.refcodes.mixin.FilenameSuffixesAccessor.FilenameSuffixesProperty

Nested classes/interfaces inherited from interface org.refcodes.properties.ResourcePropertiesFactory

ResourcePropertiesFactory.ResourcePropertiesBuilderFactory

Constructor Summary

Constructors

Constructor	Description
PolyglotPropertiesFactory()	Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.
PolyglotPropertiesFactory(boolean isDocumentRootPreserve)	Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.
PolyglotPropertiesFactory(boolean isDocumentRootPreserve, char... aDelimiters)	Initializes the PolyglotProperties.PolyglotPropertiesFactory with a predefined set of ResourcePropertiesFactory instances.
PolyglotPropertiesFactory(char... aDelimiters)	Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.
PolyglotPropertiesFactory(ResourcePropertiesFactory... aFactories)	Initializes the PolyglotProperties.PolyglotPropertiesFactory with the given ResourcePropertiesFactory instances.

Method Summary

Modifier and Type	Method	Description
String[]	getFilenameSuffixes()	Returns the filename extensions of the ResourcePropertiesFactory in the given order.
static byte[]	toByteArray(InputStream aInputStream)	Converts a byte array from an InputStream.
ResourceProperties	toProperties(File aFile, org.refcodes.runtime.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, org.refcodes.runtime.ConfigLocator aConfigLocator)	Loads the properties from the given file's path.
ResourceProperties	toProperties(Object aObj)	Will return ResourceProperties created by the first added ResourcePropertiesFactory instance.
ResourceProperties	toProperties(String aFilePath, org.refcodes.runtime.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)	Will return ResourceProperties created by the first added ResourcePropertiesFactory instance.
ResourceProperties	toProperties(Properties aProperties)	Will return ResourceProperties created by the first added ResourcePropertiesFactory instance.
ResourceProperties	toProperties(Properties.PropertiesBuilder aProperties)	Will return ResourceProperties created by the first added ResourcePropertiesFactory instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.properties.ResourcePropertiesFactory

hasFilenameSuffix, hasFilenameSuffix, toProperties, toProperties, toProperties

Constructor Details

PolyglotPropertiesFactory

public PolyglotPropertiesFactory()

Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.

PolyglotPropertiesFactory

public PolyglotPropertiesFactory(boolean isDocumentRootPreserve)

Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.

Parameters:

isDocumentRootPreserve - When set to true then unmarshaling (XML) documents will preserve the root element. As an (XML) document requires a root element, the root element often is provided merely as of syntactic reasons and must be omitted as of semantic reasons. Unmarshaling functionality therefore by default skips the root elelemt, as this is considered merely to serve as an envelope. This behavior can be overridden by setting this property to true.

PolyglotPropertiesFactory

public PolyglotPropertiesFactory(boolean isDocumentRootPreserve,
 char... aDelimiters)

Initializes the PolyglotProperties.PolyglotPropertiesFactory with a predefined set of ResourcePropertiesFactory instances.

Parameters:

isDocumentRootPreserve - When set to true then unmarshaling (XML) documents will preserve the root element. As an (XML) document requires a root element, the root element often is provided merely as of syntactic reasons and must be omitted as of semantic reasons. Unmarshaling functionality therefore by default skips the root elelemt, as this is considered merely to serve as an envelope. This behavior can be overridden by setting this property to true.

aDelimiters - The path delimiters to be used when parsing the source's properties.

PolyglotPropertiesFactory

public PolyglotPropertiesFactory(char... aDelimiters)

Initializes the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory with a predefined set of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances.

Parameters:

aDelimiters - The path delimiters to be used when parsing the source's properties.

PolyglotPropertiesFactory

public PolyglotPropertiesFactory(ResourcePropertiesFactory... aFactories)

Initializes the PolyglotProperties.PolyglotPropertiesFactory with the given ResourcePropertiesFactory instances. Them factories will be queried in the order being provided.

Parameters:

aFactories - The factories to be added.

Method Details

getFilenameSuffixes

public String[] getFilenameSuffixes()

Returns the filename extensions of the ResourcePropertiesFactory in the given order.

Specified by:

getFilenameSuffixes in interface org.refcodes.mixin.FilenameSuffixesAccessor

toProperties

public ResourceProperties toProperties(Class<?> aResourceClass,
 String aFilePath,
 org.refcodes.runtime.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 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 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 toProperties(File aFile,
 org.refcodes.runtime.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 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 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 toProperties(InputStream aInputStream)
                                throws IOException,
ParseException

Reads the properties from the given InputStream.

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aInputStream - The InputStream from which to read the 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 toProperties(Map<?,?> aProperties)

Will return ResourceProperties created by the first added ResourcePropertiesFactory instance. Create a ResourceProperties instance containing the elements of the provided Map instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ResourceProperties.

toProperties

public ResourceProperties toProperties(Object aObj)

Will return ResourceProperties created by the first added ResourcePropertiesFactory instance. Create a ResourceProperties instance containing the elements as of PathMap.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 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 ResourcePropertiesFactory

Parameters:

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

Returns:

The accordingly constructed ResourceProperties.

toProperties

public ResourceProperties toProperties(Properties aProperties)

Will return ResourceProperties created by the first added ResourcePropertiesFactory instance. Create a ResourceProperties instance containing the elements of the provided Properties instance using the path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ResourceProperties.

toProperties

public ResourceProperties toProperties(Properties.PropertiesBuilder aProperties)

Will return ResourceProperties created by the first added ResourcePropertiesFactory instance. Create a ResourceProperties instance containing the elements of the provided Properties.PropertiesBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aProperties - the properties to be added.

Returns:

The accordingly constructed ResourceProperties.

toProperties

public ResourceProperties toProperties(String aFilePath,
 org.refcodes.runtime.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 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 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 toProperties(URL aUrl)
                                throws IOException,
ParseException

Loads the properties from the given URL.

Specified by:

toProperties in interface ResourcePropertiesFactory

Parameters:

aUrl - The URL from which to read the 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.

toByteArray

public static byte[] toByteArray(InputStream aInputStream)
                          throws IOException

Converts a byte array from an InputStream.

Parameters:

aInputStream - The InputStream to be converted.

Returns:

The byte array from the InputStream.

Throws:

IOException - Thrown in case there were problems reading the InputStream.