com.pnfsoftware.jeb.core.properties.IPropertyDefinitionManager |
![]() |
API for a property definition manager (PDM). PDMs can be chained to form a hierarchy of properties. Each PDM defines a region. PDM regions are standard lower case identifiers. Properties are camel case identifiers. Naming convention should be enforced, not optional. Member methods should throw a RuntimeException on failure.
PDM support the definition of boolean, integer, and string properties.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract IPropertyDefinition |
addDefinition(String name, IPropertyType type, String description)
Add a property definition.
| ||||||||||
abstract IPropertyDefinition |
addDefinition(String name, IPropertyType type, String description, int flags)
Add a property definition.
| ||||||||||
abstract IPropertyDefinition |
addInternalDefinition(String name, IPropertyType type)
Add an internal property definition.
| ||||||||||
abstract void |
attachToParent(IPropertyDefinitionManager parent)
Attach this PDM a parent PDM.
| ||||||||||
abstract IPropertyDefinitionManager |
getChild(String name)
Get a child PDM by region name.
| ||||||||||
abstract List<IPropertyDefinitionManager> |
getChildren()
Get the children of this PDM.
| ||||||||||
abstract IPropertyDefinition |
getDefinition(String name)
Retrieve a property definition.
| ||||||||||
abstract List<IPropertyDefinition> |
getDefinitions()
Get the list of definitions within this PDM.
| ||||||||||
abstract String |
getNamespace()
Fully qualified namespace of the currently PDM, eg ".com.pnfsoftware.foo"
| ||||||||||
abstract IPropertyDefinitionManager |
getParent()
Get the parent of this PDM.
| ||||||||||
abstract String |
getRegion()
Region name (lower case), never null.
| ||||||||||
abstract boolean |
isRoot()
Determine if this PDM is a root manager.
| ||||||||||
abstract boolean |
registerChild(IPropertyDefinitionManager child)
Register a PDM as a child region.
| ||||||||||
abstract void |
removeDefinition(String name)
Remove a property.
|
Add a property definition.
name | the property name |
---|---|
type | the property type |
description | an optional description string |
Add a property definition.
Add an internal property definition.
name | the property name |
---|---|
type | the property type |
Attach this PDM a parent PDM. The region name within the parent's children namespace must be available.
parent | a parent PDM |
---|
Get a child PDM by region name.
name | the region name |
---|
Get the children of this PDM.
Retrieve a property definition.
name | the simple (local) property name (of a property managed by this manager) |
---|
Get the list of definitions within this PDM. Hierarchies are not navigated, only the current level properties are returned.
Fully qualified namespace of the currently PDM, eg ".com.pnfsoftware.foo"
Get the parent of this PDM.
Region name (lower case), never null. A root region is the empty-string.
Determine if this PDM is a root manager.
Register a PDM as a child region. To be used in conjunction with attachToParent.
child | the child PDM |
---|
Remove a property.
name | the property name |
---|