xdoclet.modules.jmx

Class JMXTagsHandler

public class JMXTagsHandler extends AbstractProgramElementTagsHandler

Version: $Revision: 1.12 $

Author: Jerome Bernard (jerome.bernard@xtremejava.com) Ara Abrahamian (ara_e@email.com)

UNKNOWN: 31 January 2002 namespace = "Jmx" attributes - XXX: Does this need to be synchronized? ifIsGetterMethod, ifIsSetterMethod - TODO: There is a big overlap here with stuff in ejb - have a look.

Field Summary
protected Mapattributes
Collection of attributes.
protected MethodTagsHandlerhandler
For use in extracting method names.
protected intindex
For looping through indexed tags.
Method Summary
StringconstructorSignature()
Describe what the method does
voidforAllIndexedConstructorParams(String template, Properties attributes)
Describe what the method does
voidforAllIndexedMethodParams(String template, Properties attributes)
Describe what the method does
protected StringgetMBeanName(XClass clazz)
Implementation of JMXTagsHandler.
voidifHasAttributeDescription(String template, Properties attributes)
voidifIsGetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.
voidifIsSetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.
StringindexedConstructorParamValue(Properties attributes)
Describe what the method does
StringindexedMethodParamValue(Properties attributes)
protected booleanisGetterMethod()
protected booleanisSetterMethod()
StringmbeanName()
Returns the MBean name for the current class.

Field Detail

attributes

protected Map attributes
Collection of attributes. XXX: Does this need to be synchronized?

handler

protected MethodTagsHandler handler
For use in extracting method names.

index

protected int index
For looping through indexed tags.

Method Detail

constructorSignature

public String constructorSignature()
Describe what the method does

Returns: Describe the return value

Throws: XDocletException Describe the exception

forAllIndexedConstructorParams

public void forAllIndexedConstructorParams(String template, Properties attributes)
Describe what the method does

Parameters: template Describe what the parameter does attributes Describe what the parameter does

Throws: XDocletException Describe the exception

forAllIndexedMethodParams

public void forAllIndexedMethodParams(String template, Properties attributes)
Describe what the method does

Parameters: template Describe what the parameter does attributes Describe what the parameter does

Throws: XDocletException Describe the exception

getMBeanName

protected String getMBeanName(XClass clazz)
Implementation of JMXTagsHandler.

Parameters: clazz

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

ifHasAttributeDescription

public void ifHasAttributeDescription(String template, Properties attributes)

Parameters: template attributes

Throws: XDocletException

UNKNOWN: type = "block"

ifIsGetterMethod

public void ifIsGetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.

Parameters: template attributes

Throws: XDocletException

UNKNOWN: type = "block" description = "Executes the block if the current method is a getter"

ifIsSetterMethod

public void ifIsSetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.

Parameters: template attributes

Throws: XDocletException

UNKNOWN: type = "block" description = "Executes the block if the current method is a setter"

indexedConstructorParamValue

public String indexedConstructorParamValue(Properties attributes)
Describe what the method does

Parameters: attributes Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException Describe the exception

indexedMethodParamValue

public String indexedMethodParamValue(Properties attributes)

Parameters: attributes Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException Describe the exception

UNKNOWN: refactor common code with indexedConstructorParamValue into a private method

isGetterMethod

protected boolean isGetterMethod()

Returns: The GetterMethod value

UNKNOWN: (Aslak) this is very general stuff. It should be implemented higher up in the hierarchy if it isn't already done somewhere

isSetterMethod

protected boolean isSetterMethod()

Returns: The SetterMethod value

UNKNOWN: (Aslak) this is very general stuff. It should be implemented higher up in the hierarchy if it isn't already done somewhere

mbeanName

public String mbeanName()
Returns the MBean name for the current class. Looks for the name parameter in the jmx:mbean tag on the current class.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

See Also: JMXTagsHandler

UNKNOWN: type = "content" description = "Returns the MBean name for the current class. Looks for * the name parameter in the jmx:mbean tag on the current class."