com.apelon.apps.dts.editor.modules
Interface DTSModuleConfig

public interface DTSModuleConfig

Defines the methods to access and save module specific properties.

Since:

3.4.0

Version:

1.0

Author:

Apelon Inc.

Method Summary

boolean	getBooleanProperty(String prop, boolean defaultValue) Return the value of a boolean property type.
int	getIntProperty(String prop, int defaultValue) Return the value of an int property type.
String	getProperty(String prop) Return the value of this property.
String	getProperty(String prop, String defaultValue) Returns the value of the specified property.
void	saveProperties() Save any property values previously stored using the storeProperty method.
void	storeBooleanProperty(String prop, boolean bool) Store the boolean value for this property.
void	storeIntProperty(String prop, int i) Store the integer value for this property.
void	storeProperty(String prop, String value) Store the value for this property.

Method Detail

getProperty

String getProperty(String prop)

Return the value of this property.

Parameters:

prop - the name of this property

Returns:

the value of this property

Since:

DTS 3.4.0

getProperty

String getProperty(String prop,
                   String defaultValue)

Returns the value of the specified property. The method returns the default value argument if the property is not found.

Parameters:

prop - the name of this property

defaultValue - a default value to return if the property is not set

Returns:

the value of this property

Since:

DTS 3.4.0

getBooleanProperty

boolean getBooleanProperty(String prop,
                           boolean defaultValue)

Return the value of a boolean property type. The method returns the default value argument if the property is not found.

Parameters:

prop - the name of this property

defaultValue - a default value to return if the property is not set

Returns:

true or false

Since:

DTS 3.4.0

getIntProperty

int getIntProperty(String prop,
                   int defaultValue)

Return the value of an int property type. The method returns the default value argument if the property is not found.

Parameters:

prop - the name of this property

defaultValue - a default value to return if the property is not set

Returns:

the value of this property

Since:

DTS 3.4.0

storeProperty

void storeProperty(String prop,
                   String value)

Store the value for this property.

Parameters:

prop - the name of this property

value - a default value to return if the property is not set

Since:

DTS 3.4.0

storeBooleanProperty

void storeBooleanProperty(String prop,
                          boolean bool)

Store the boolean value for this property.

Parameters:

prop - the name of this property

bool - a default value to return if the property is not set

Since:

DTS 3.4.0

storeIntProperty

void storeIntProperty(String prop,
                      int i)

Store the integer value for this property.

Parameters:

prop - the name of this property

i - a default value to return if the property is not set

Since:

DTS 3.4.0

saveProperties

void saveProperties()
                    throws Exception

Save any property values previously stored using the storeProperty method.

Throws:

Exception

Since:

DTS 3.4.0