public
interface
IPropertyManager
implements IEventSource| com.pnfsoftware.jeb.core.properties.IPropertyManager |
 Known Indirect Subclasses
|
Class Overview
Define a property manager (PM). Implementations of this class connect an
IPropertyDefinitionManager and an IConfiguration together to offer clients a
single point of entry to set and get legal properties.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | DEPTH_CONFIGURATION_ONLY | ||||||||||
| int | DEPTH_FULL | ||||||||||
| int | DEPTH_MASTER | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Boolean |
getBoolean(String name)
Retrieve a boolean property.
| ||||||||||
| abstract IConfiguration |
getConfiguration()
Get the configuration object.
| ||||||||||
| abstract Integer |
getInteger(String name)
Retrieve an integer property value.
| ||||||||||
| abstract IPropertyDefinitionManager |
getPropertyDefinitionManager()
Get the PDM.
| ||||||||||
| abstract String |
getString(String name)
Retrieve a string property value.
| ||||||||||
| abstract Object |
getValue(String name)
Get a property value.
| ||||||||||
| abstract Object |
getValue(String name, int checkingDepth, boolean validateValue)
Get a property value with optional control on depth search and property validation.
| ||||||||||
| abstract void |
setBoolean(String name, Boolean value)
Set a boolean property.
| ||||||||||
| abstract void |
setInteger(String name, Integer value)
Set an integer property value
| ||||||||||
| abstract void |
setString(String name, String value)
Get a string property value.
| ||||||||||
| abstract boolean |
setValue(String name, Object value, boolean validateValue)
Set a property value with optional control on property validation.
| ||||||||||
| abstract boolean |
setValue(String name, Object value)
Set a property value.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.pnfsoftware.jeb.util.events.IEventSource
| |||||||||||
Constants
public static final int DEPTH_CONFIGURATION_ONLY
Constant Value:
0
(0x00000000)
public static final int DEPTH_FULL
Constant Value:
3
(0x00000003)
public static final int DEPTH_MASTER
Constant Value:
1
(0x00000001)
Public Methods
public abstract Boolean getBoolean (String name)
Retrieve a boolean property.
Parameters
| name | the property name |
|---|
Returns
- the property value
public abstract IConfiguration getConfiguration ()
Get the configuration object.
Returns
- the configuration object
public abstract Integer getInteger (String name)
Retrieve an integer property value.
Parameters
| name | the property name |
|---|
Returns
- the property value
public abstract IPropertyDefinitionManager getPropertyDefinitionManager ()
Get the PDM.
Returns
- the PDM
public abstract String getString (String name)
Retrieve a string property value.
Parameters
| name | the property name |
|---|
Returns
- the property value
public abstract Object getValue (String name)
Get a property value.
Parameters
| name | the property name |
|---|
Returns
- the property value
public abstract Object getValue (String name, int checkingDepth, boolean validateValue)
Get a property value with optional control on depth search and property validation. By default, property getters do a maximum depth search and validate values.
Parameters
| name | the property name |
|---|---|
| checkingDepth | one of the DEPTH_* constant |
| validateValue | validate the property value against its definition |
Returns
- the property value object (Boolean, Integer, or String), null on error
public abstract void setBoolean (String name, Boolean value)
Set a boolean property.
Parameters
| name | the property name |
|---|---|
| value | the property value |
public abstract void setInteger (String name, Integer value)
Set an integer property value
Parameters
| name | the property name |
|---|---|
| value | the property value |
public abstract void setString (String name, String value)
Get a string property value.
Parameters
| name | the property name |
|---|---|
| value | the property value |
public abstract boolean setValue (String name, Object value, boolean validateValue)
Set a property value with optional control on property validation. By default, property setters validate values.
Parameters
| name | the property name |
|---|---|
| value | the property value |
| validateValue | validate the property value against its definition |
Returns
- true on success
public abstract boolean setValue (String name, Object value)
Set a property value.
Parameters
| name | the property name |
|---|---|
| value | the property value |
Returns
- true on success