org.intellimate.izou.sdk.properties

Class PropertiesAssistant

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.properties.PropertiesAssistant

All Implemented Interfaces:

Identifiable, ContextProvider, Loggable, LoggedExceptionCallback, ReloadableFile, ExceptionCallback

public class PropertiesAssistant
extends AddOnModule
implements ReloadableFile

Manages property files, and is also a ReloadableFile

Unlike most manager classes in Izou, the PropertiesManager is included in every AddOn instance

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
PropertiesAssistant(Context context, String addOnID)

Method Summary

Modifier and Type	Method and Description
String	getDefaultPropertiesPath() Gets the path to default properties file path (the file which is copied into the real properties on start)
EventPropertiesAssistant	getEventPropertiesAssistant() Gets the EventPropertiesAssistant
Properties	getProperties() Gets the properties object
File	getPropertiesFile() Gets the path to properties file (the real properties file - as opposed to the defaultProperties.txt file)
String	getPropertiesPath() Gets the path to properties file (the real properties file - as opposed to the defaultProperties.txt file)
String	getProperty(String key) Searches for the property with the specified key in this property list.
void	initProperties() Initializes properties in the addOn.
void	registerUpdateListener(java.util.function.Consumer<PropertiesAssistant> listener) the listener will always be called, when the Properties-file changes.
void	reloadFile(String eventType)
void	setProperty(String key, String value) Calls the HashTable method put.

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

getID, isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

PropertiesAssistant

public PropertiesAssistant(Context context,
                           String addOnID)

Method Detail

getEventPropertiesAssistant

public EventPropertiesAssistant getEventPropertiesAssistant()

Gets the EventPropertiesAssistant

Returns:

the EventPropertiesAssistant

getProperty

public String getProperty(String key)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in this property list with the specified key value.

getProperties

public Properties getProperties()

Gets the properties object

Returns:

the properties object

setProperty

public void setProperty(String key,
                        String value)

Calls the HashTable method put. Provided for parallelism with the getProperty method. Enforces use of strings for * property keys and values. The value returned is the result of the HashTable call to put.

Parameters:

key - the key to be placed into this property list.

value - the value corresponding to key.

getPropertiesPath

public String getPropertiesPath()

Gets the path to properties file (the real properties file - as opposed to the defaultProperties.txt file)

Returns:

path to properties file

getPropertiesFile

public File getPropertiesFile()

Gets the path to properties file (the real properties file - as opposed to the defaultProperties.txt file)

Returns:

path to properties file

registerUpdateListener

public void registerUpdateListener(java.util.function.Consumer<PropertiesAssistant> listener)

the listener will always be called, when the Properties-file changes.

Parameters:

listener - the listener

getDefaultPropertiesPath

public String getDefaultPropertiesPath()

Gets the path to default properties file path (the file which is copied into the real properties on start)

Returns:

path to default properties file

initProperties

public void initProperties()

Initializes properties in the addOn. Creates new properties file using default properties.

reloadFile

public void reloadFile(String eventType)

Specified by:

reloadFile in interface ReloadableFile