fr.paris.lutece.util

Class PropertiesService

java.lang.Object

fr.paris.lutece.util.PropertiesService

public class PropertiesService
extends Object

This class provides utility methods to read values of the properties stored in the .properties file of the application.

Constructor Summary

Constructors

Constructor and Description
PropertiesService(String strRootPath) Constructor should define the base root path for properties files

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertiesDirectory(String strRelativePath) Add properties from all files found in a given directory
void	addPropertiesFile(String strRelativePath, String strFilename) Add properties from a properties file
Properties	getProperties() Gets properties
String	getProperty(String strProperty) Returns the value of a variable defined in the .properties file of the application as a String
String	getProperty(String strProperty, String strDefault) Returns the value of a variable defined in the .properties file of the application as a String
boolean	getPropertyBoolean(String strProperty, boolean bDefault) Returns the value of a variable defined in the .properties file of the application as an boolean
int	getPropertyInt(String strProperty, int nDefault) Returns the value of a variable defined in the .properties file of the application as an int
long	getPropertyLong(String strProperty, long lDefault) Returns the value of a variable defined in the .properties file of the application as an long
void	reload(String strFilename) Reload a properties file .
void	reloadAll() Reload all properties files

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesService

public PropertiesService(String strRootPath)

Constructor should define the base root path for properties files

Parameters:

strRootPath - The root path

Method Detail

addPropertiesFile

public void addPropertiesFile(String strRelativePath,
                     String strFilename)
                       throws FileNotFoundException,
                              IOException

Add properties from a properties file

Parameters:

strRelativePath - Relative path from the root path

strFilename - The filename of the properties file (ie: config.properties)

Throws:

FileNotFoundException - If the file is not found

IOException - If an error occurs reading the file

addPropertiesDirectory

public void addPropertiesDirectory(String strRelativePath)
                            throws IOException

Add properties from all files found in a given directory

Parameters:

strRelativePath - Relative path from the root path

Throws:

IOException - If an error occurs reading the file

reload

public void reload(String strFilename)
            throws IOException

Reload a properties file .

Parameters:

strFilename - The filename of the properties file

Throws:

IOException - If an error occurs reading the file

reloadAll

public void reloadAll()
               throws IOException

Reload all properties files

Throws:

IOException - If an error occurs reading the file

getProperty

public String getProperty(String strProperty)

Returns the value of a variable defined in the .properties file of the application as a String

Parameters:

strProperty - The variable name

Returns:

The variable value read in the properties file

getProperty

public String getProperty(String strProperty,
                 String strDefault)

Returns the value of a variable defined in the .properties file of the application as a String

Parameters:

strProperty - The variable name

strDefault - The default value which is returned if no value is found for the variable in the .properties file.

Returns:

The variable value read in the properties file

getPropertyInt

public int getPropertyInt(String strProperty,
                 int nDefault)

Returns the value of a variable defined in the .properties file of the application as an int

Parameters:

strProperty - The variable name

nDefault - The default value which is returned if no value is found for the variable in the .properties file, or if the value is not numeric

Returns:

The variable value read in the properties file

getPropertyLong

public long getPropertyLong(String strProperty,
                   long lDefault)

Returns the value of a variable defined in the .properties file of the application as an long

Parameters:

strProperty - The variable name

lDefault - The default value which is returned if no value is found for the variable in the le downloadFile .properties. .properties file.

Returns:

The variable value read in the properties file

getPropertyBoolean

public boolean getPropertyBoolean(String strProperty,
                         boolean bDefault)

Returns the value of a variable defined in the .properties file of the application as an boolean

Parameters:

strProperty - The variable name

bDefault - The default value which is returned if no value is found for the variable in the le downloadFile .properties. .properties file.

Returns:

The variable value read in the properties file

getProperties

public Properties getProperties()

Gets properties

Returns:

All properties