com.ibm.broker.config.appdev

Class NodeProperty

  • java.lang.Object
    • com.ibm.broker.config.appdev.NodeProperty
  • All Implemented Interfaces:
    java.io.Serializable


    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
     
    See Also:
    Serialized Form
    • Constructor Detail

      • NodeProperty

        public NodeProperty(java.lang.String propertyName,
                            NodeProperty.Usage usage,
                            NodeProperty.Type propertyValueType,
                            java.lang.Object defaultValue)
        Used to create a NodeProperty
        Parameters:
        propertyName - String ; the name of the property
        usage - Usage ; the usage Mandatory or Optional of the property
        propertyValueType - Type ; the value of the property
        defaultValue - Object ; the default value of the property
      • NodeProperty

        public 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
        Parameters:
        propertyName - String ; the name of the property
        usage - Usage ; the usage Mandatory or Optional of the property
        configurable - boolean ; a configurable runtime property
        propertyValueType - Type ; the value of the property
        defaultValue - Object ; the default value of the property
        compiler - 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.
      • NodeProperty

        public 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
        Parameters:
        propertyName - String ; the name of the property
        usage - Usage ; the usage Mandatory or Optional of the property
        propertyValueType - Type ; the value of the property
        defaultValue - Object ; the default value of the property
        enumerationClass - Class ; the class which is the enumeration class
      • NodeProperty

        public 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
        Parameters:
        propertyName - String ; the name of the property
        usage - Usage ; the usage Mandatory or Optional of the property
        configurable - boolean ; a configurable runtime property
        propertyValueType - Type ; the value of the property
        defaultValue - Object ; the default value of the property
        enumerationClass - Class ; the class which is the enumeration class
        compiler - 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.
    • Method Detail

      • getPropertyName

        public java.lang.String getPropertyName()
        Returns:
        String; the name of this node property
      • setPropertyValue

        public NodeProperty setPropertyValue(java.lang.String propertyValue)
        Parameters:
        propertyValue - String; the value of this property
      • getPropertyDefaultValue

        public java.lang.Object getPropertyDefaultValue()
        Returns:
        Object; the default value of this property
      • getUsage

        public NodeProperty.Usage getUsage()
        Returns:
        Usage; the usage of this property either Mandatory or Optional
      • getPropertyValue

        public java.lang.Object getPropertyValue()
        Returns:
        Object; the value of the property
      • setpropertyValueType

        public void setpropertyValueType(NodeProperty.Type propertyValueType)
      • isConfigurable

        public boolean isConfigurable()
        Returns:
        boolean; is the property configurable at runtime
      • setConfigurable

        public void setConfigurable(boolean configurable)
      • getCompiler

        public java.lang.String getCompiler()
        Default is an empty string which means no compilation for the property
        Returns:
        String; the compiler class to use to compile this property
      • getEditor

        public java.lang.String getEditor()
        Default is empty string which shows a string editor in the BAREditor
        Returns:
        String; the editor class to use to visualise this property in the BAR Editor
      • getBundleName

        public java.lang.String getBundleName()
        Returns:
        String; the bundle name of this node property
      • getPluginId

        public java.lang.String getPluginId()
        Returns:
        String; the plugin class of this node property
      • getEnumerationClass

        public java.lang.Class<?> getEnumerationClass()
        Returns:
        Class; the class which holds the Enumerated values if this node property has enumerations
      • getDisplayName

        public java.lang.String getDisplayName()
        Returns:
        String; the Default Locale specific Display name for this property
      • getDisplayName

        public java.lang.String getDisplayName(java.util.Locale locale)
        Returns:
        String; the provided Locale specific Display name for this property
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object