Package com.saperion.common.config.loader

Class FilePropertiesLoader

java.lang.Object

com.saperion.common.config.loader.AbstractPropertiesLoader

com.saperion.common.config.loader.FilePropertiesLoader

All Implemented Interfaces:

PropertiesLoader

public final class FilePropertiesLoader
extends AbstractPropertiesLoader

This FilePropertiesLoader loads '.properties'-files. When loading a file it first attempts to find the file in the class-path. If not found, it tries to find the file in the file-system.

The path to look for the PropertiesResources to load can be configured using the according constructor.

An instance of this FilePropertiesLoader can be used in several threads concurrently.

Author:

sts

Constructor Summary

Constructors

Constructor	Description
FilePropertiesLoader(java.lang.String filePath)	Constructs a FilePropertiesLoader using the given file-path.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getFileName(PropertiesResource propertiesResource)	Returns the filename used by this PropertiesLoader when it tries to load the given PropertiesResource.
java.lang.String	getFilePath(PropertiesResource propertiesResource)	Returns the file path build by this PropertiesLoader when it tries to load the given PropertiesResource.
java.util.Properties	load(PropertiesResource propertiesResource)	Loads the given PropertiesResource if present.
java.lang.String	toString()

Methods inherited from class com.saperion.common.config.loader.AbstractPropertiesLoader

loadAsMap

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePropertiesLoader

public FilePropertiesLoader(java.lang.String filePath)

Constructs a FilePropertiesLoader using the given file-path. The file-path is appended as prefix to the file name when this PropertiesLoader loads a PropertiesResource.

Parameters:

filePath - the file-path to use for loading the PropertiesResources. May not be null or empty.

Method Detail

load

public java.util.Properties load(PropertiesResource propertiesResource)
                          throws ConfigurationException

Description copied from interface: PropertiesLoader

Loads the given PropertiesResource if present. Returns the properties as a Properties object.

Parameters:

propertiesResource - the PropertiesResource to load.

Returns:

the loaded Properties

Throws:

ConfigurationException - if the PropertiesResource could not be loaded.

See Also:

PropertiesResource, Properties

getFileName

public static java.lang.String getFileName(PropertiesResource propertiesResource)

Returns the filename used by this PropertiesLoader when it tries to load the given PropertiesResource.

Parameters:

propertiesResource - the PropertiesResource to get the filename for.

Returns:

filename used by this PropertiesLoader when it loads the given PropertiesResource

getFilePath

public java.lang.String getFilePath(PropertiesResource propertiesResource)

Returns the file path build by this PropertiesLoader when it tries to load the given PropertiesResource.

Parameters:

propertiesResource - the PropertiesResource to get the search path for.

Returns:

the file path build by this PropertiesLoader when it tries to load the given PropertiesResource.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object