Package org.europa.together.application

Class PropertyFileReader

java.lang.Object

org.europa.together.application.PropertyFileReader

All Implemented Interfaces:

PropertyReader

@Repository
public class PropertyFileReader
extends Object
implements PropertyReader

Implementation of the Property Reader.

Field Summary

Fields inherited from interface org.europa.together.business.PropertyReader

FEATURE_ID

Constructor Summary

Constructors

Constructor	Description
PropertyFileReader()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	addProperty(String key, String value)	Add a single property to the property list.
boolean	addPropertyList(Map<String,String> resource)	Extend property list by Map<String, String>.
boolean	appendPropertiesFromClasspath(String resource)	Load a property list from an given file inside the classpath. eg: org/europa/together/properties/file.properties
boolean	appendPropertiesFromFile(String resource)	Load a property list from an external file. eg: /home/usr/application/file.properties
boolean	clear()	Clear the entire property list.
int	count()	Counts the amount of all properties and return the value.
Boolean	getPropertyAsBoolean(String key)	Get the value of a property as boolean.Allowed values are: - 0 | 1 - false | true - FALSE | TRUE All other values will evaluate to null.
Double	getPropertyAsDouble(String key)	Get the property value as Double.
Float	getPropertyAsFloat(String key)	Get the property value as Float.
Integer	getPropertyAsInt(String key)	Get the value of a property as Integer.
String	getPropertyAsString(String key)	Get the property value as String.
Map<String,String>	getPropertyList()	Get the full property list as Map.
boolean	removeProperty(String key)	Remove a property by the given key from the list.
boolean	updateProperty(String key, String value)	Update an existing property entry.

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyFileReader

public PropertyFileReader()

Constructor.

Method Details

addProperty

public boolean addProperty(String key,
 String value)

Description copied from interface: PropertyReader

Add a single property to the property list. If the property already exist in the list, the new entry will not added and the method return FALSE.

Specified by:

addProperty in interface PropertyReader

Parameters:

key - as String

value - as String

Returns:

true on success

addPropertyList

public boolean addPropertyList(Map<String,String> resource)

Description copied from interface: PropertyReader

Extend property list by Map<String, String>.

Specified by:

addPropertyList in interface PropertyReader

Parameters:

resource - as Map

Returns:

true on success

appendPropertiesFromClasspath

public boolean appendPropertiesFromClasspath(String resource)
                                      throws UnsupportedEncodingException,
IOException

Description copied from interface: PropertyReader

Load a property list from an given file inside the classpath. eg: org/europa/together/properties/file.properties

Specified by:

appendPropertiesFromClasspath in interface PropertyReader

Parameters:

resource - as String

Returns:

true on success

Throws:

IOException - case of error

UnsupportedEncodingException

appendPropertiesFromFile

public boolean appendPropertiesFromFile(String resource)
                                 throws IOException

Description copied from interface: PropertyReader

Load a property list from an external file. eg: /home/usr/application/file.properties

Specified by:

appendPropertiesFromFile in interface PropertyReader

Parameters:

resource - as String

Returns:

true on success

Throws:

IOException - case of error

clear

public boolean clear()

Description copied from interface: PropertyReader

Clear the entire property list.

Specified by:

clear in interface PropertyReader

Returns:

true on success

removeProperty

public boolean removeProperty(String key)

Description copied from interface: PropertyReader

Remove a property by the given key from the list. If the property not exists the method return false.

Specified by:

removeProperty in interface PropertyReader

Parameters:

key - as String

Returns:

true on success

updateProperty

public boolean updateProperty(String key,
 String value)

Description copied from interface: PropertyReader

Update an existing property entry. In the case the entry don't exist, it will be created.

Specified by:

updateProperty in interface PropertyReader

Parameters:

key - as String

value - as String

Returns:

true on success

count

public int count()

Description copied from interface: PropertyReader

Counts the amount of all properties and return the value.

Specified by:

count in interface PropertyReader

Returns:

count of properties as int

getPropertyAsBoolean

public Boolean getPropertyAsBoolean(String key)
                             throws MisconfigurationException

Description copied from interface: PropertyReader

Get the value of a property as boolean.Allowed values are:
- 0 | 1
- false | true
- FALSE | TRUE
All other values will evaluate to null.

Specified by:

getPropertyAsBoolean in interface PropertyReader

Parameters:

key - as String

Returns:

property as Boolean

Throws:

MisconfigurationException - case of error

getPropertyAsDouble

public Double getPropertyAsDouble(String key)
                           throws MisconfigurationException

Description copied from interface: PropertyReader

Get the property value as Double.

Specified by:

getPropertyAsDouble in interface PropertyReader

Parameters:

key - as String

Returns:

property as Double

Throws:

MisconfigurationException - case of error

getPropertyAsFloat

public Float getPropertyAsFloat(String key)
                         throws MisconfigurationException

Description copied from interface: PropertyReader

Get the property value as Float.

Specified by:

getPropertyAsFloat in interface PropertyReader

Parameters:

key - as String

Returns:

property as Float

Throws:

MisconfigurationException - case of error

getPropertyAsInt

public Integer getPropertyAsInt(String key)
                         throws MisconfigurationException

Description copied from interface: PropertyReader

Get the value of a property as Integer.

Specified by:

getPropertyAsInt in interface PropertyReader

Parameters:

key - as String

Returns:

property as Integer

Throws:

MisconfigurationException - case of error

getPropertyAsString

public String getPropertyAsString(String key)
                           throws MisconfigurationException

Description copied from interface: PropertyReader

Get the property value as String.

Specified by:

getPropertyAsString in interface PropertyReader

Parameters:

key - as String

Returns:

property as String

Throws:

MisconfigurationException - case of error

getPropertyList

public Map<String,String> getPropertyList()

Description copied from interface: PropertyReader

Get the full property list as Map.

Specified by:

getPropertyList in interface PropertyReader

Returns:

propertyList as Map