Package org.apache.commons.modeler
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 String
protected String
protected String
protected Method
protected ModelMBeanAttributeInfo
TheModelMBeanAttributeInfo
object that corresponds to thisAttributeInfo
instance.protected boolean
protected String
protected boolean
(package private) static final long
protected String
protected Method
protected String
protected boolean
Fields inherited from class org.apache.commons.modeler.FeatureInfo
description, fields, name
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate and return aModelMBeanAttributeInfo
object 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 String
getMethodName
(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.boolean
isIs()
Is this a boolean attribute with an "is" getter?boolean
Is this attribute readable by management applications?boolean
Is this attribute writeable by management applications?void
setDefault
(String defaultStringValue) void
setDescription
(String description) Override thedescription
property setter.void
setDisplayName
(String displayName) void
setGetMethod
(String getMethod) void
setGetMethodObj
(Method getMethodObj) void
setIs
(boolean is) void
Override thename
property setter.void
setPersist
(String persist) void
setReadable
(boolean readable) void
setSetMethod
(String setMethod) void
setSetMethodObj
(Method setMethodObj) void
void
setWriteable
(boolean writeable) toString()
Return a string representation of this attribute descriptor.Methods inherited from class org.apache.commons.modeler.FeatureInfo
addField, addFields, getDescription, getFields, getName
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
info
TheModelMBeanAttributeInfo
object that corresponds to thisAttributeInfo
instance. -
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 thedescription
property setter.- Overrides:
setDescription
in classFeatureInfo
- Parameters:
description
- The new description
-
setName
Override thename
property setter.- Overrides:
setName
in 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 aModelMBeanAttributeInfo
object that corresponds to the attribute described by this instance. -
toString
Return a string representation of this attribute descriptor. -
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?
-