Class AttributeInfo
java.lang.Object
org.apache.commons.modeler.FeatureInfo
org.apache.commons.modeler.AttributeInfo
- All Implemented Interfaces:
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected Stringprotected Stringprotected Methodprotected ModelMBeanAttributeInfoTheModelMBeanAttributeInfoobject that corresponds to thisAttributeInfoinstance.protected booleanprotected Stringprotected boolean(package private) static final longprotected Stringprotected Methodprotected Stringprotected booleanFields inherited from class FeatureInfo
description, fields, name -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate and return aModelMBeanAttributeInfoobject that corresponds to the attribute described by this instance.Default value.The display name of this attribute.The name of the property getter method, if non-standard.private StringgetMethodName(String name, boolean getter, boolean is) Create and return the name of a default property getter or setter method, according to the specified values.Persistence policy.The name of the property setter method, if non-standard.getType()The fully qualified Java class name of this attribute.booleanisIs()Is this a boolean attribute with an "is" getter?booleanIs this attribute readable by management applications?booleanIs this attribute writeable by management applications?voidsetDefault(String defaultStringValue) voidsetDescription(String description) Override thedescriptionproperty setter.voidsetDisplayName(String displayName) voidsetGetMethod(String getMethod) voidsetGetMethodObj(Method getMethodObj) voidsetIs(boolean is) voidOverride thenameproperty setter.voidsetPersist(String persist) voidsetReadable(boolean readable) voidsetSetMethod(String setMethod) voidsetSetMethodObj(Method setMethodObj) voidvoidsetWriteable(boolean writeable) toString()Return a string representation of this attribute descriptor.Methods inherited from class FeatureInfo
addField, addFields, getDescription, getFields, getName
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
info
TheModelMBeanAttributeInfoobject that corresponds to thisAttributeInfoinstance. -
displayName
-
getMethod
-
setMethod
-
getMethodObj
-
setMethodObj
-
readable
protected boolean readable -
writeable
protected boolean writeable -
is
protected boolean is -
type
-
persist
-
defaultStringValue
-
-
Constructor Details
-
AttributeInfo
public AttributeInfo()
-
-
Method Details
-
setDescription
Override thedescriptionproperty setter.- Overrides:
setDescriptionin classFeatureInfo- Parameters:
description- The new description
-
setName
Override thenameproperty setter.- Overrides:
setNamein classFeatureInfo- Parameters:
name- The new name
-
getDisplayName
The display name of this attribute. -
setDisplayName
-
getGetMethod
The name of the property getter method, if non-standard. -
setGetMethod
-
getGetMethodObj
-
setGetMethodObj
-
getSetMethodObj
-
setSetMethodObj
-
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
The name of the property setter method, if non-standard. -
setSetMethod
-
getType
The fully qualified Java class name of this attribute. -
setType
-
isWriteable
public boolean isWriteable()Is this attribute writeable by management applications? -
setWriteable
public void setWriteable(boolean writeable) -
getPersist
Persistence policy. All persistent attributes should have this attribute set. Valid values: ??? -
setPersist
-
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
-
createAttributeInfo
Create and return aModelMBeanAttributeInfoobject that corresponds to the attribute described by this instance. -
toString
-
getMethodName
Create and return the name of a default property getter or setter method, according to the specified values.- Parameters:
name- Name of the property itselfgetter- Do we want a get method (versus a set method)?is- If returning a getter, do we want the "is" form?
-