org.universAAL.ri.gateway.configuration

Class UpdatedPropertiesFile

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.universAAL.ri.gateway.configuration.UpdatedPropertiesFile

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:

ConfigurationFile

public abstract class UpdatedPropertiesFile
extends Properties

Author:

amedrano

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected File	propertiesFile The properties file.

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
UpdatedPropertiesFile(File propFile) Create a Properties that is linked and updated with the propfile

Method Summary

Modifier and Type	Method and Description
protected abstract void	addDefaults(Properties defaults) to be implemented to add the default values at the start if there is no file.
protected boolean	checkPropertiesVersion() Checks for updates the properties file, and updates the properties.
abstract String	getComments() Get the comments for the Property file.
String	getProperty(String key) Access to the property file.
String	getProperty(String key, String defaultValue) Access to the property file.
void	loadProperties() load configuration properties from a file, setting the default for those which are not defined.
Object	setProperty(String key, String newValue) Update the property file.
protected void	storeProperties() Save the current properties in the file.

Methods inherited from class java.util.Properties

list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

propertiesFile

protected File propertiesFile

The properties file.

Constructor Detail

UpdatedPropertiesFile

public UpdatedPropertiesFile(File propFile)

Create a Properties that is linked and updated with the propfile

Parameters:

propFile - the properties file

Method Detail

getComments

public abstract String getComments()

Get the comments for the Property file.

Returns:

addDefaults

protected abstract void addDefaults(Properties defaults)

to be implemented to add the default values at the start if there is no file.

Parameters:

defaults -

loadProperties

public void loadProperties()
                    throws IOException

load configuration properties from a file, setting the default for those which are not defined.

Throws:

IOException

See Also:

HTMLUserGenerator#properties

checkPropertiesVersion

protected boolean checkPropertiesVersion()

Checks for updates the properties file, and updates the properties.

Returns:

true if the properties have been updated.

storeProperties

protected void storeProperties()
                        throws IOException

Save the current properties in the file.

Throws:

IOException

getProperty

public final String getProperty(String key)

Access to the property file.

Overrides:

getProperty in class Properties

Parameters:

string - Key of property to access

Returns:

String Value of the property

See Also:

HTMLUserGenerator#properties

getProperty

public final String getProperty(String key,
                                String defaultValue)

Access to the property file.

Overrides:

getProperty in class Properties

Parameters:

key - Key of property to access

defaultValue - default value for the property if isn't in the property file.

Returns:

String Value of the property.

See Also:

HTMLUserGenerator#properties

setProperty

public final Object setProperty(String key,
                                String newValue)

Update the property file.

Overrides:

setProperty in class Properties

Parameters:

key - Key of property to access

newValue - New value for the property.

Returns:

See Also:

HTMLUserGenerator#properties