org.apache.commons.modeler

Class AttributeInfo

public class AttributeInfo extends FeatureInfo implements 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

Field Summary
protected StringdefaultStringValue
protected StringdisplayName
protected StringgetMethod
protected MethodgetMethodObj
protected ModelMBeanAttributeInfoinfo
The ModelMBeanAttributeInfo object that corresponds to this AttributeInfo instance.
protected booleanis
protected Stringpersist
protected booleanreadable
protected StringsetMethod
protected MethodsetMethodObj
protected Stringtype
protected booleanwriteable
Method Summary
ModelMBeanAttributeInfocreateAttributeInfo()
Create and return a ModelMBeanAttributeInfo object that corresponds to the attribute described by this instance.
StringgetDefault()
Default value.
StringgetDisplayName()
The display name of this attribute.
StringgetGetMethod()
The name of the property getter method, if non-standard.
MethodgetGetMethodObj()
StringgetPersist()
Persistence policy.
StringgetSetMethod()
The name of the property setter method, if non-standard.
MethodgetSetMethodObj()
StringgetType()
The fully qualified Java class name of this attribute.
booleanisIs()
Is this a boolean attribute with an "is" getter?
booleanisReadable()
Is this attribute readable by management applications?
booleanisWriteable()
Is this attribute writeable by management applications?
voidsetDefault(String defaultStringValue)
voidsetDescription(String description)
Override the description property setter.
voidsetDisplayName(String displayName)
voidsetGetMethod(String getMethod)
voidsetGetMethodObj(Method getMethodObj)
voidsetIs(boolean is)
voidsetName(String name)
Override the name property setter.
voidsetPersist(String persist)
voidsetReadable(boolean readable)
voidsetSetMethod(String setMethod)
voidsetSetMethodObj(Method setMethodObj)
voidsetType(String type)
voidsetWriteable(boolean writeable)
StringtoString()
Return a string representation of this attribute descriptor.

Field Detail

defaultStringValue

protected String defaultStringValue

displayName

protected String displayName

getMethod

protected String getMethod

getMethodObj

protected transient Method getMethodObj

info

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

is

protected boolean is

persist

protected String persist

readable

protected boolean readable

setMethod

protected String setMethod

setMethodObj

protected transient Method setMethodObj

type

protected String type

writeable

protected boolean writeable

Method Detail

createAttributeInfo

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

getDefault

public 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 )

getDisplayName

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

getGetMethod

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

getGetMethodObj

public Method getGetMethodObj()

getPersist

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

getSetMethod

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

getSetMethodObj

public Method getSetMethodObj()

getType

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

isIs

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

isReadable

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

isWriteable

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

setDefault

public void setDefault(String defaultStringValue)

setDescription

public void setDescription(String description)
Override the description property setter.

Parameters: description The new description

setDisplayName

public void setDisplayName(String displayName)

setGetMethod

public void setGetMethod(String getMethod)

setGetMethodObj

public void setGetMethodObj(Method getMethodObj)

setIs

public void setIs(boolean is)

setName

public void setName(String name)
Override the name property setter.

Parameters: name The new name

setPersist

public void setPersist(String persist)

setReadable

public void setReadable(boolean readable)

setSetMethod

public void setSetMethod(String setMethod)

setSetMethodObj

public void setSetMethodObj(Method setMethodObj)

setType

public void setType(String type)

setWriteable

public void setWriteable(boolean writeable)

toString

public String toString()
Return a string representation of this attribute descriptor.
Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.