org.refcodes.configuration

Interface ResourcePropertiesMixin<B extends ResourcePropertiesMixin<B>>

public interface ResourcePropertiesMixin<B extends ResourcePropertiesMixin<B>>

This mixin provides builder additions (as of the builder pattern for chained configuring method calls) for "dynamic" ResourceProperties: As ResourceProperties are immutable from an interface's point of view, there are no mutating methods provided. Sub-types of the ResourceProperties might need to load the properties after instantiation. Such types might implement this interface, providing means to load from resources after instantiation.

Method Summary

Modifier and Type	Method and Description
B	withFile(File aFile) Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toConfigDirs().
B	withFilePath(String aFilePath) Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toConfigDirs().
B	withInputStream(InputStream aInputStream) Reads the properties from the given InputStream.
B	withUrl(URL aUrl) Loads the properties from the given URL.

Method Detail

withFile

B withFile(File aFile)
    throws IOException,
           ParseException

Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toConfigDirs().

Parameters:

aFile - The file of the properties to load.

Returns:

This instance as of the builder pattern for chained method calls.

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.

withInputStream

B withInputStream(InputStream aInputStream)
           throws IOException,
                  ParseException

Reads the properties from the given InputStream.

Parameters:

aInputStream - The InputStream from which to read the properties.

Returns:

This instance as of the builder pattern for chained method calls.

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.

withFilePath

B withFilePath(String aFilePath)
        throws IOException,
               ParseException

Loads a properties file from the file directly or (if not found) from first folder containing such a file as of the specification for the method RuntimeUtility.toConfigDirs().

Parameters:

aFilePath - The file of the properties file to load.

Returns:

This instance as of the builder pattern for chained method calls.

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.

withUrl

B withUrl(URL aUrl)
   throws IOException,
          ParseException

Loads the properties from the given URL.

Parameters:

aUrl - The URL from which to read the properties.

Returns:

This instance as of the builder pattern for chained method calls.

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.