Package org.apache.commons.modeler

Class ParameterInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class ParameterInfo
extends FeatureInfo
implements java.io.Serializable

    Internal configuration information for a Parameter descriptor.

    Version:
    $Revision: 480402 $ $Date: 2006-11-29 04:43:23 +0000 (Wed, 29 Nov 2006) $
    Author:
    Craig R. McClanahan
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) javax.management.MBeanParameterInfo info
      The MBeanParameterInfo object that corresponds to this ParameterInfo instance.
      (package private) static long serialVersionUID  
      protected java.lang.String type  

    • Constructor Summary

      Constructors 
      Constructor Description
      ParameterInfo()
      Standard zero-arguments constructor.
      ParameterInfo​(java.lang.String name, java.lang.String type, java.lang.String description)
      Special constructor for setting up parameters programatically.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.management.MBeanParameterInfo createParameterInfo()
      Create and return a MBeanParameterInfo object that corresponds to the parameter described by this instance.
      java.lang.String getType()
      The fully qualified Java class name of this parameter.
      void setDescription​(java.lang.String description)
      Override the description property setter.
      void setName​(java.lang.String name)
      Override the name property setter.
      void setType​(java.lang.String type)  
      java.lang.String toString()
      Return a string representation of this parameter descriptor.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • info

        transient javax.management.MBeanParameterInfo info
        The MBeanParameterInfo object that corresponds to this ParameterInfo instance.

      • type

        protected java.lang.String type

    • Constructor Detail

      • ParameterInfo

        public ParameterInfo()
        Standard zero-arguments constructor.

      • ParameterInfo

        public ParameterInfo​(java.lang.String name,
                     java.lang.String type,
                     java.lang.String description)
        Special constructor for setting up parameters programatically.
        Parameters:
        name - Name of this parameter
        type - Java class of this parameter
        description - Description of this parameter

    • Method Detail

      • setDescription

        public void setDescription​(java.lang.String description)
        Override the description property setter.
        Overrides:
        setDescription in class FeatureInfo
        Parameters:
        description - The new description

      • setName

        public void setName​(java.lang.String name)
        Override the name property setter.
        Overrides:
        setName in class FeatureInfo
        Parameters:
        name - The new name

      • getType

        public java.lang.String getType()
        The fully qualified Java class name of this parameter.

      • setType

        public void setType​(java.lang.String type)

      • createParameterInfo

        public javax.management.MBeanParameterInfo createParameterInfo()
        Create and return a MBeanParameterInfo object that corresponds to the parameter described by this instance.

      • toString

        public java.lang.String toString()
        Return a string representation of this parameter descriptor.
        Overrides:
        toString in class java.lang.Object