org.ow2.proactive.core.properties

Class PACommonPropertiesHelper

java.lang.Object

org.ow2.proactive.core.properties.PACommonPropertiesHelper

@PublicAPI
public class PACommonPropertiesHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
PACommonPropertiesHelper(PAPropertiesLazyLoader propertiesLoader)

Method Summary

Modifier and Type	Method and Description
String	getCmdLine(String key) Returns the string to be passed on the command line The property surrounded by '-D' and '='
Map<String,Object>	getPropertiesAsHashMap() Return all properties as a HashMap.
boolean	getValueAsBoolean(String key, PropertyType type, String defaultValue) Returns the value of this property as a boolean.
int	getValueAsInt(String key, PropertyType type, String defaultValue) Returns the value of this property as an integer.
List<String>	getValueAsList(String key, PropertyType type, String separator, boolean allowEmpty, String defaultValue) Returns the value of this property as a List of strings.
long	getValueAsLong(String key, PropertyType type, String defaultValue) Returns the value of this property as an integer.
String	getValueAsString(String key, String defaultValue) Returns the value of this property as a string.
String	getValueAsStringOrNull(String key) Returns the value of this property as a string.
boolean	isSet(String key, String defaultValue) Return true if this property is set, false otherwise.
void	unSet(String key) unsets this property
void	updateProperties(String filename) Override properties defined in the default configuration file, by properties defined in another file.
void	updateProperty(String key, String value) Set the value of this property to the given one.

Methods inherited from class java.lang.Object

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

Constructor Detail

PACommonPropertiesHelper

public PACommonPropertiesHelper(PAPropertiesLazyLoader propertiesLoader)

Method Detail

updateProperty

public void updateProperty(String key,
                           String value)

Set the value of this property to the given one.

Parameters:

value - the new value to set.

isSet

public boolean isSet(String key,
                     String defaultValue)

Return true if this property is set, false otherwise.

Returns:

true if this property is set, false otherwise.

unSet

public void unSet(String key)

unsets this property

getCmdLine

public String getCmdLine(String key)

Returns the string to be passed on the command line The property surrounded by '-D' and '='

Returns:

the string to be passed on the command line

updateProperties

public void updateProperties(String filename)

Override properties defined in the default configuration file, by properties defined in another file. Call this method implies the default properties to be loaded

Parameters:

filename - path of file containing some properties to override

getPropertiesAsHashMap

public Map<String,Object> getPropertiesAsHashMap()

Return all properties as a HashMap.

getValueAsInt

public int getValueAsInt(String key,
                         PropertyType type,
                         String defaultValue)

Returns the value of this property as an integer. If value is not an integer, an exception will be thrown.

Returns:

the value of this property.

getValueAsLong

public long getValueAsLong(String key,
                           PropertyType type,
                           String defaultValue)

Returns the value of this property as an integer. If value is not an integer, an exception will be thrown.

Returns:

the value of this property.

getValueAsString

public String getValueAsString(String key,
                               String defaultValue)

Returns the value of this property as a string.

Returns:

the value of this property.

getValueAsList

public List<String> getValueAsList(String key,
                                   PropertyType type,
                                   String separator,
                                   boolean allowEmpty,
                                   String defaultValue)

Returns the value of this property as a List of strings.

Parameters:

separator - the separator to use

Returns:

the list of values of this property.

getValueAsStringOrNull

public String getValueAsStringOrNull(String key)

Returns the value of this property as a string. If the property is not defined, then null is returned

Returns:

the value of this property.

getValueAsBoolean

public boolean getValueAsBoolean(String key,
                                 PropertyType type,
                                 String defaultValue)

Returns the value of this property as a boolean. If value is not a boolean, an exception will be thrown.
The behavior of this method is the same as the Boolean.parseBoolean(String s).

Returns:

the value of this property.