Package com.pnfsoftware.jeb.core.properties.impl

Class PropertyDefinitionManager

java.lang.Object

com.pnfsoftware.jeb.core.properties.impl.PropertyDefinitionManager

All Implemented Interfaces:

IPropertyDefinitionManager

public class PropertyDefinitionManager
extends Object
implements IPropertyDefinitionManager

Standard implementation of IPropertyDefinitionManager.

Properties can be organized in regions, sub-regions, and display groups.

Field Summary

Fields inherited from interface com.pnfsoftware.jeb.core.properties.IPropertyDefinitionManager

FLAG_ALLOW_LOOK_UP, FLAG_MAY_ALPHASORT_CHILDREN, FLAG_SHOULD_NOT_ALPHASORT_CHILDREN, pdmGroupDefault

Constructor Summary

Constructors

Constructor	Description
PropertyDefinitionManager()	Create a new PDM.
PropertyDefinitionManager(String region)	Create a new PDM.
PropertyDefinitionManager(String region, IPropertyDefinitionManager parent)	Create a new PDM with default flags and no description.
PropertyDefinitionManager(String region, IPropertyDefinitionManager parent, String description, int flags)	Create a new PDM.

Method Summary

Modifier and Type	Method	Description
IPropertyDefinition	addDefinition(String name, IPropertyType type, String description)	Add a property definition.
IPropertyDefinition	addDefinition(String name, IPropertyType type, String description, int flags)	Add a property definition.
IPropertyDefinitionGroup	addGroup(String name)	Create a group.
IPropertyDefinition	addInternalDefinition(String name, IPropertyType type)	Add an internal property definition.
IPropertyDefinition	addInternalDefinition(String name, IPropertyType type, String description)	Add an internal property definition.
void	attachToParent(IPropertyDefinitionManager parentManager)	Attach this PDM a parent PDM.
IPropertyDefinitionManager	getChild(String name)	Get a child PDM by region name.
Collection<IPropertyDefinitionManager>	getChildren()	Get the children of this PDM.
IPropertyDefinition	getDefinition(String name)	Retrieve a property definition.
Collection<IPropertyDefinition>	getDefinitions()	Get the list of definitions within this PDM.
String	getDescription()	Get a human-readable description of this namespace.
int	getFlags()	Get the PDM flags.
IPropertyDefinitionGroup	getGroup(String name)	Retrieve an existing group.
Collection<IPropertyDefinitionGroup>	getGroups()	Retrieve all groups in this PDM.
String	getNamespace()	Fully qualified namespace of this PDM, eg ".com.pnfsoftware.foo"
IPropertyDefinitionManager	getParent()	Get the parent of this PDM.
String	getRegion()	Region name (lower case), never null.
boolean	hasChildren()	Determine whether this PDM has child regions.
boolean	hasDefinitions()	Determine whether this PDM defines local properties.
boolean	isRoot()	Determine if this PDM is a root manager.
boolean	registerChild(IPropertyDefinitionManager child)	Register a PDM as a child region.
void	removeDefinition(String name)	Remove a property.
boolean	removeGroup(String name)	Remove a group.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyDefinitionManager

public PropertyDefinitionManager(String region,
 IPropertyDefinitionManager parent,
 String description,
 int flags)

Create a new PDM.

Parameters:

region - set to null to create a root PDM, else must be a valid region name. A valid region name is a valid Java identifier name

parent - optional parent PDM, used to form a tree of properties, such as .region0.region1.PropertyXyz

description - optional namespace description

flags - manager flags

PropertyDefinitionManager

public PropertyDefinitionManager(String region,
 IPropertyDefinitionManager parent)

Create a new PDM with default flags and no description.

Parameters:

region - region name, or null for a root PDM

parent - optional parent PDM

PropertyDefinitionManager

public PropertyDefinitionManager(String region)

Create a new PDM. Same as PropertyDefinitionManager(region, null)

Parameters:

region - set to null to create a root PDM, else must be a valid region name

PropertyDefinitionManager

public PropertyDefinitionManager()

Create a new PDM. Same as PropertyDefinitionManager(null, null)

Method Details

attachToParent

public void attachToParent(IPropertyDefinitionManager parentManager)

Description copied from interface: IPropertyDefinitionManager

Attach this PDM a parent PDM. The region name within the parent's children namespace must be available.

Specified by:

attachToParent in interface IPropertyDefinitionManager

Parameters:

parentManager - a parent PDM

registerChild

public boolean registerChild(IPropertyDefinitionManager child)

Description copied from interface: IPropertyDefinitionManager

Register a PDM as a child region. To be used in conjunction with attachToParent.

Specified by:

registerChild in interface IPropertyDefinitionManager

Parameters:

child - the child PDM

Returns:

success indicator

getRegion

public String getRegion()

Description copied from interface: IPropertyDefinitionManager

Region name (lower case), never null. A root region is the empty-string.

Specified by:

getRegion in interface IPropertyDefinitionManager

Returns:

the region name

isRoot

public boolean isRoot()

Description copied from interface: IPropertyDefinitionManager

Determine if this PDM is a root manager.

Specified by:

isRoot in interface IPropertyDefinitionManager

Returns:

true if this manager has no parent region

getFlags

public int getFlags()

Description copied from interface: IPropertyDefinitionManager

Get the PDM flags.

Specified by:

getFlags in interface IPropertyDefinitionManager

Returns:

a combination of FLAG_* constants

getDescription

public String getDescription()

Description copied from interface: IPropertyDefinitionManager

Get a human-readable description of this namespace.

Specified by:

getDescription in interface IPropertyDefinitionManager

Returns:

the description, or null

getParent

public IPropertyDefinitionManager getParent()

Description copied from interface: IPropertyDefinitionManager

Get the parent of this PDM.

Specified by:

getParent in interface IPropertyDefinitionManager

Returns:

the parent, null if this PDM is a root

getNamespace

public String getNamespace()

Description copied from interface: IPropertyDefinitionManager

Fully qualified namespace of this PDM, eg ".com.pnfsoftware.foo"

Specified by:

getNamespace in interface IPropertyDefinitionManager

Returns:

the FQNS

hasChildren

public boolean hasChildren()

Description copied from interface: IPropertyDefinitionManager

Determine whether this PDM has child regions.

Specified by:

hasChildren in interface IPropertyDefinitionManager

Returns:

true if child regions are registered

getChildren

public Collection<IPropertyDefinitionManager> getChildren()

Description copied from interface: IPropertyDefinitionManager

Get the children of this PDM.

Specified by:

getChildren in interface IPropertyDefinitionManager

Returns:

a list of children, potentially empty (never null)

getChild

public IPropertyDefinitionManager getChild(String name)

Description copied from interface: IPropertyDefinitionManager

Get a child PDM by region name.

Specified by:

getChild in interface IPropertyDefinitionManager

Parameters:

name - the region name

Returns:

the child, null if does not exist

hasDefinitions

public boolean hasDefinitions()

Description copied from interface: IPropertyDefinitionManager

Determine whether this PDM defines local properties.

Specified by:

hasDefinitions in interface IPropertyDefinitionManager

Returns:

true if local property definitions exist

getDefinition

public IPropertyDefinition getDefinition(String name)

Description copied from interface: IPropertyDefinitionManager

Retrieve a property definition.

Specified by:

getDefinition in interface IPropertyDefinitionManager

Parameters:

name - the simple (local) property name (of a property managed by this manager)

Returns:

the definition of null

getDefinitions

public Collection<IPropertyDefinition> getDefinitions()

Description copied from interface: IPropertyDefinitionManager

Get the list of definitions within this PDM. Hierarchies are not navigated, only the current level properties are returned.

Specified by:

getDefinitions in interface IPropertyDefinitionManager

Returns:

never null

addDefinition

public IPropertyDefinition addDefinition(String name,
 IPropertyType type,
 String description)

Description copied from interface: IPropertyDefinitionManager

Add a property definition.

Specified by:

addDefinition in interface IPropertyDefinitionManager

Parameters:

name - the property name

type - the property type

description - an optional description string

Returns:

the newly created property definition

addDefinition

public IPropertyDefinition addDefinition(String name,
 IPropertyType type,
 String description,
 int flags)

Description copied from interface: IPropertyDefinitionManager

Add a property definition.

Specified by:

addDefinition in interface IPropertyDefinitionManager

Parameters:

name - the property name

type - the property type

description - an optional description string

flags - property flags, using IPropertyDefinition.FLAG_INTERNAL and related constants

Returns:

the newly created property definition

addInternalDefinition

public IPropertyDefinition addInternalDefinition(String name,
 IPropertyType type)

Description copied from interface: IPropertyDefinitionManager

Add an internal property definition.

Specified by:

addInternalDefinition in interface IPropertyDefinitionManager

Parameters:

name - the property name

type - the property type

Returns:

the newly created property definition

addInternalDefinition

public IPropertyDefinition addInternalDefinition(String name,
 IPropertyType type,
 String description)

Description copied from interface: IPropertyDefinitionManager

Add an internal property definition.

Specified by:

addInternalDefinition in interface IPropertyDefinitionManager

Parameters:

name - the property name

type - the property type

description - optional description

Returns:

the newly created property definition

removeDefinition

public void removeDefinition(String name)

Description copied from interface: IPropertyDefinitionManager

Remove a property.

Specified by:

removeDefinition in interface IPropertyDefinitionManager

Parameters:

name - the property name

toString

public String toString()

Overrides:

toString in class Object

addGroup

public IPropertyDefinitionGroup addGroup(String name)

Description copied from interface: IPropertyDefinitionManager

Create a group.

Specified by:

addGroup in interface IPropertyDefinitionManager

Parameters:

name - non-empty group name

Returns:

the newly created group

getGroups

public Collection<IPropertyDefinitionGroup> getGroups()

Description copied from interface: IPropertyDefinitionManager

Retrieve all groups in this PDM. Note that the default group (whose name is empty) always exists and is returned as first element of the collection.

Specified by:

getGroups in interface IPropertyDefinitionManager

Returns:

the groups of this manager

getGroup

public IPropertyDefinitionGroup getGroup(String name)

Description copied from interface: IPropertyDefinitionManager

Retrieve an existing group.

Specified by:

getGroup in interface IPropertyDefinitionManager

Parameters:

name - a non-empty name

Returns:

the matching group, or null if none exists

removeGroup

public boolean removeGroup(String name)

Description copied from interface: IPropertyDefinitionManager

Remove a group. When a group is removed, all its property definitions are added to the default group.

Specified by:

removeGroup in interface IPropertyDefinitionManager

Parameters:

name - non-empty group name (the default group cannot be removed)

Returns:

success indicator