public interface ModulePropertyInterface
This interface defines required methods for another interfaces to support properties in a way that the module implementing this interface would be compatible with UCOT core.
Method Summary | |
---|---|
void |
applyProperties()
Applies current properties for the module. |
java.util.Properties |
getProperties()
Returns module's properties. |
java.util.Properties |
loadDefaultProperties()
Method which returns the factory default properties for the module. |
void |
loadProperties()
Loads settings from the current properties XML file. |
void |
saveProperties()
Saves current properties to the properties XML file. |
void |
setProperties(java.util.Properties properties)
Sets options for the adapter. |
Method Detail |
---|
java.util.Properties getProperties()
Returns module's properties.
void setProperties(java.util.Properties properties)
Sets options for the adapter.
Notice that this does not need to be an perfect set of properties for this module because these properties should be merged to the current properties. So it is possible to change only one property value by giving a new property object with the new value for the given key.
properties
- Properties for the adapter.void applyProperties() throws BadPropertyValueException
Applies current properties for the module.
BadPropertyValueException
- In this case exception
is thrown only if either the given parser or heuristic
does not exist.void saveProperties() throws java.io.IOException
Saves current properties to the properties XML file.
java.io.IOException
- Exception is thrown if something went wrong.void loadProperties() throws java.io.IOException
Loads settings from the current properties XML file.
java.io.IOException
- Exception is thrown if something went wrong.java.util.Properties loadDefaultProperties()
Method which returns the factory default properties for the module.