org.jahia.utils.properties

Class PropertiesManager

java.lang.Object

org.jahia.utils.properties.PropertiesManager

public class PropertiesManager
extends Object

desc: This class provides to you a *super interface* for properties. It allows you to create a new properties file, set properties, remove properties, get properties, get properties from an existing properties object or from a flat file, get a complete properties object, and you can store the new properties object where you want on the filesystem. The store method keep your base properties file design (not like the store() method from java properties object)! Copyright: Copyright (c) 2002 Company: Jahia Ltd

Version:

1.0

Author:

Alexandre Kraft

Field Summary

Fields

Modifier and Type	Field and Description
Properties	properties
String	propertiesFilePath

Constructor Summary

Constructors

Constructor and Description
PropertiesManager() Default constructor.
PropertiesManager(Properties properties) Default constructor.
PropertiesManager(String propertiesFilePath) Default constructor.

Method Summary

Modifier and Type	Method and Description
Properties	getPropertiesObject() Get the properties object for the instance of this class.
String	getProperty(String propertyName) Get a property value by its name.
void	removeProperty(String propertyName) Remove a property by its name.
void	setProperty(String propertyName, String propvalue) Set a property value by its name.
void	storeProperties() Store new properties and values in the properties file.
void	storeProperties(String propertiesFilePath) Store new properties and values in the properties file.
static String	string2Property(String originalValue) Convert a standard string to a property-compatible string.

Methods inherited from class java.lang.Object

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

Field Detail

properties

public Properties properties

propertiesFilePath

public String propertiesFilePath

Constructor Detail

PropertiesManager

public PropertiesManager()

Default constructor.

PropertiesManager

public PropertiesManager(String propertiesFilePath)

Default constructor.

Parameters:

propertiesFilePath - The filesystem path from the file is loaded.

PropertiesManager

public PropertiesManager(Properties properties)

Default constructor.

Parameters:

properties - The properties object used to define base properties.

Method Detail

getProperty

public String getProperty(String propertyName)

Get a property value by its name.

Parameters:

propertyName - The property name to get its value.

Returns:

Returns a String containing the value of the property name.

setProperty

public void setProperty(String propertyName,
                        String propvalue)

Set a property value by its name.

Parameters:

propertyName - The property name to set.

propvalue - The property value to set.

removeProperty

public void removeProperty(String propertyName)

Remove a property by its name.

Parameters:

propertyName - The property name to remove.

storeProperties

public void storeProperties()

Store new properties and values in the properties file. The file writed is the same, using the same file path, as the file loaded before.

storeProperties

public void storeProperties(String propertiesFilePath)

Store new properties and values in the properties file. If the file where you want to write doesn't exists, the file is created.

Parameters:

propertiesFilePath - The filesystem path where the file is saved.

getPropertiesObject

public Properties getPropertiesObject()

Get the properties object for the instance of this class.

Returns:

The properties object for the instance of this class.

string2Property

public static String string2Property(String originalValue)

Convert a standard string to a property-compatible string.

Parameters:

originalValue - The string that you want to convert.

Returns:

The string converted.