public class NodeProperty
extends java.lang.Object
implements java.io.Serializable
Each NodeProperty instance holds a simple property of a node. Each NodeProperty has a Type and Usage of either mandatory or optional. You can retrieve a NodeProperty name and value as well as a NodeProperty default value.
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ xxxxx.x 2010-08-10 dstorey v7.0.0.2 Release xxxxx.x 2011-07-06 dstorey v8.0.0.0 Release
Modifier and Type | Class and Description |
---|---|
static class |
NodeProperty.Type |
static class |
NodeProperty.Usage |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Constructor and Description |
---|
NodeProperty(java.lang.String propertyName,
NodeProperty.Usage usage,
boolean configurable,
NodeProperty.Type propertyValueType,
java.lang.Object defaultValue,
java.lang.Class<?> enumerationClass,
java.lang.String compiler,
java.lang.String editor,
java.lang.String bundleName,
java.lang.String pluginId)
Used to create a NodeProperty which has enumerated values
|
NodeProperty(java.lang.String propertyName,
NodeProperty.Usage usage,
boolean configurable,
NodeProperty.Type propertyValueType,
java.lang.Object defaultValue,
java.lang.String compiler,
java.lang.String editor,
java.lang.String bundleName,
java.lang.String pluginId)
Used to create a NodeProperty
|
NodeProperty(java.lang.String propertyName,
NodeProperty.Usage usage,
NodeProperty.Type propertyValueType,
java.lang.Object defaultValue)
Used to create a NodeProperty
|
NodeProperty(java.lang.String propertyName,
NodeProperty.Usage usage,
NodeProperty.Type propertyValueType,
java.lang.Object defaultValue,
java.lang.Class<?> enumerationClass)
Used to create a NodeProperty which has enumerated values
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBundleName() |
java.lang.String |
getCompiler()
Default is an empty string which means no compilation for the property
|
java.lang.String |
getDisplayName() |
java.lang.String |
getDisplayName(java.util.Locale locale) |
java.lang.String |
getEditor()
Default is empty string which shows a string editor in the BAREditor
|
java.lang.Class<?> |
getEnumerationClass() |
java.lang.String |
getPluginId() |
java.lang.Object |
getPropertyDefaultValue() |
java.lang.String |
getPropertyName() |
java.lang.Object |
getPropertyValue() |
NodeProperty.Type |
getPropertyValueType() |
NodeProperty.Usage |
getUsage() |
boolean |
isConfigurable() |
void |
setConfigurable(boolean configurable) |
NodeProperty |
setPropertyValue(java.lang.String propertyValue) |
void |
setpropertyValueType(NodeProperty.Type propertyValueType) |
java.lang.String |
toString() |
public static final java.lang.String copyright
public NodeProperty(java.lang.String propertyName, NodeProperty.Usage usage, NodeProperty.Type propertyValueType, java.lang.Object defaultValue)
propertyName
- String ; the name of the propertyusage
- Usage ; the usage Mandatory or Optional of the propertypropertyValueType
- Type ; the value of the propertydefaultValue
- Object ; the default value of the propertypublic NodeProperty(java.lang.String propertyName, NodeProperty.Usage usage, boolean configurable, NodeProperty.Type propertyValueType, java.lang.Object defaultValue, java.lang.String compiler, java.lang.String editor, java.lang.String bundleName, java.lang.String pluginId)
propertyName
- String ; the name of the propertyusage
- Usage ; the usage Mandatory or Optional of the propertyconfigurable
- boolean ; a configurable runtime propertypropertyValueType
- Type ; the value of the propertydefaultValue
- Object ; the default value of the propertycompiler
- String ; internal compiler used. Default is no compiler.editor
- String ; internal editor used. Default is no editor.bundleName
- String ; internal bundle used.pluginId
- String ; internal plugin id used.public NodeProperty(java.lang.String propertyName, NodeProperty.Usage usage, NodeProperty.Type propertyValueType, java.lang.Object defaultValue, java.lang.Class<?> enumerationClass)
propertyName
- String ; the name of the propertyusage
- Usage ; the usage Mandatory or Optional of the propertypropertyValueType
- Type ; the value of the propertydefaultValue
- Object ; the default value of the propertyenumerationClass
- Class ; the class which is the enumeration classpublic NodeProperty(java.lang.String propertyName, NodeProperty.Usage usage, boolean configurable, NodeProperty.Type propertyValueType, java.lang.Object defaultValue, java.lang.Class<?> enumerationClass, java.lang.String compiler, java.lang.String editor, java.lang.String bundleName, java.lang.String pluginId)
propertyName
- String ; the name of the propertyusage
- Usage ; the usage Mandatory or Optional of the propertyconfigurable
- boolean ; a configurable runtime propertypropertyValueType
- Type ; the value of the propertydefaultValue
- Object ; the default value of the propertyenumerationClass
- Class ; the class which is the enumeration classcompiler
- String ; internal compiler used. Default is no compiler.editor
- String ; internal editor used. Default is no editor.bundleName
- String ; internal bundle used.pluginId
- String ; internal plugin id used.public java.lang.String getPropertyName()
public NodeProperty setPropertyValue(java.lang.String propertyValue)
propertyValue
- String; the value of this propertypublic java.lang.Object getPropertyDefaultValue()
public NodeProperty.Usage getUsage()
public java.lang.Object getPropertyValue()
public void setpropertyValueType(NodeProperty.Type propertyValueType)
public boolean isConfigurable()
public void setConfigurable(boolean configurable)
public java.lang.String getCompiler()
public java.lang.String getEditor()
public java.lang.String getBundleName()
public java.lang.String getPluginId()
public NodeProperty.Type getPropertyValueType()
public java.lang.Class<?> getEnumerationClass()
public java.lang.String getDisplayName()
public java.lang.String getDisplayName(java.util.Locale locale)
public java.lang.String toString()
toString
in class java.lang.Object