Package org.apache.commons.modeler

Class AttributeInfo

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

    Internal configuration information for an Attribute 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
      protected java.lang.String defaultStringValue  
      protected java.lang.String displayName  
      protected java.lang.String getMethod  
      protected java.lang.reflect.Method getMethodObj  
      protected javax.management.modelmbean.ModelMBeanAttributeInfo info
      The ModelMBeanAttributeInfo object that corresponds to this AttributeInfo instance.
      protected boolean is  
      protected java.lang.String persist  
      protected boolean readable  
      (package private) static long serialVersionUID  
      protected java.lang.String setMethod  
      protected java.lang.reflect.Method setMethodObj  
      protected java.lang.String type  
      protected boolean writeable  

    • Constructor Summary

      Constructors 
      Constructor Description
      AttributeInfo()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.management.modelmbean.ModelMBeanAttributeInfo createAttributeInfo()
      Create and return a ModelMBeanAttributeInfo object that corresponds to the attribute described by this instance.
      java.lang.String getDefault()
      Default value.
      java.lang.String getDisplayName()
      The display name of this attribute.
      java.lang.String getGetMethod()
      The name of the property getter method, if non-standard.
      java.lang.reflect.Method getGetMethodObj()  
      private java.lang.String getMethodName​(java.lang.String name, boolean getter, boolean is)
      Create and return the name of a default property getter or setter method, according to the specified values.
      java.lang.String getPersist()
      Persistence policy.
      java.lang.String getSetMethod()
      The name of the property setter method, if non-standard.
      java.lang.reflect.Method getSetMethodObj()  
      java.lang.String getType()
      The fully qualified Java class name of this attribute.
      boolean isIs()
      Is this a boolean attribute with an "is" getter?
      boolean isReadable()
      Is this attribute readable by management applications?
      boolean isWriteable()
      Is this attribute writeable by management applications?
      void setDefault​(java.lang.String defaultStringValue)  
      void setDescription​(java.lang.String description)
      Override the description property setter.
      void setDisplayName​(java.lang.String displayName)  
      void setGetMethod​(java.lang.String getMethod)  
      void setGetMethodObj​(java.lang.reflect.Method getMethodObj)  
      void setIs​(boolean is)  
      void setName​(java.lang.String name)
      Override the name property setter.
      void setPersist​(java.lang.String persist)  
      void setReadable​(boolean readable)  
      void setSetMethod​(java.lang.String setMethod)  
      void setSetMethodObj​(java.lang.reflect.Method setMethodObj)  
      void setType​(java.lang.String type)  
      void setWriteable​(boolean writeable)  
      java.lang.String toString()
      Return a string representation of this attribute descriptor.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • info

        protected transient javax.management.modelmbean.ModelMBeanAttributeInfo info
        The ModelMBeanAttributeInfo object that corresponds to this AttributeInfo instance.

      • displayName

        protected java.lang.String displayName

      • getMethod

        protected java.lang.String getMethod

      • setMethod

        protected java.lang.String setMethod

      • getMethodObj

        protected transient java.lang.reflect.Method getMethodObj

      • setMethodObj

        protected transient java.lang.reflect.Method setMethodObj

      • readable

        protected boolean readable

      • writeable

        protected boolean writeable

      • is

        protected boolean is

      • type

        protected java.lang.String type

      • persist

        protected java.lang.String persist

      • defaultStringValue

        protected java.lang.String defaultStringValue

    • Constructor Detail

      • AttributeInfo

        public AttributeInfo()

    • 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

      • getDisplayName

        public java.lang.String getDisplayName()
        The display name of this attribute.

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)

      • getGetMethod

        public java.lang.String getGetMethod()
        The name of the property getter method, if non-standard.

      • setGetMethod

        public void setGetMethod​(java.lang.String getMethod)

      • getGetMethodObj

        public java.lang.reflect.Method getGetMethodObj()

      • setGetMethodObj

        public void setGetMethodObj​(java.lang.reflect.Method getMethodObj)

      • getSetMethodObj

        public java.lang.reflect.Method getSetMethodObj()

      • setSetMethodObj

        public void setSetMethodObj​(java.lang.reflect.Method setMethodObj)

      • isIs

        public boolean isIs()
        Is this a boolean attribute with an "is" getter?

      • setIs

        public void setIs​(boolean is)

      • isReadable

        public boolean isReadable()
        Is this attribute readable by management applications?

      • setReadable

        public void setReadable​(boolean readable)

      • getSetMethod

        public java.lang.String getSetMethod()
        The name of the property setter method, if non-standard.

      • setSetMethod

        public void setSetMethod​(java.lang.String setMethod)

      • getType

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

      • setType

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

      • isWriteable

        public boolean isWriteable()
        Is this attribute writeable by management applications?

      • setWriteable

        public void setWriteable​(boolean writeable)

      • getPersist

        public java.lang.String getPersist()
        Persistence policy. All persistent attributes should have this attribute set. Valid values: ???

      • setPersist

        public void setPersist​(java.lang.String persist)

      • getDefault

        public java.lang.String getDefault()
        Default value. If set, it can provide info to the user and it can be used by persistence mechanism to generate a more compact representation ( a value may not be saved if it's default )

      • setDefault

        public void setDefault​(java.lang.String defaultStringValue)

      • createAttributeInfo

        public javax.management.modelmbean.ModelMBeanAttributeInfo createAttributeInfo()
        Create and return a ModelMBeanAttributeInfo object that corresponds to the attribute described by this instance.

      • toString

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

      • getMethodName

        private java.lang.String getMethodName​(java.lang.String name,
                                       boolean getter,
                                       boolean is)
        Create and return the name of a default property getter or setter method, according to the specified values.
        Parameters:
        name - Name of the property itself
        getter - Do we want a get method (versus a set method)?
        is - If returning a getter, do we want the "is" form?