xdoclet.modules.jmx

Class JMXTagsHandler


public class JMXTagsHandler
extends xdoclet.tagshandler.AbstractProgramElementTagsHandler

Version:
$Revision: 1.12 $
Authors:
Jerome Bernard (jerome.bernard@xtremejava.com)
Ara Abrahamian (ara_e@email.com)
xdoclet.taghandler
namespace = "Jmx"
created
31 January 2002
To do:
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 Map
attributes
Collection of attributes.
protected xdoclet.tagshandler.MethodTagsHandler
handler
For use in extracting method names.
protected int
index
For looping through indexed tags.

Fields inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler

currentToken, matchPattern, tagTokenizer

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Method Summary

String
constructorSignature()
Describe what the method does
void
forAllIndexedConstructorParams(String template, Properties attributes)
Describe what the method does
void
forAllIndexedMethodParams(String template, Properties attributes)
Describe what the method does
protected String
getMBeanName(XClass clazz)
Implementation of mbeanName().
void
ifHasAttributeDescription(String template, Properties attributes)
void
ifIsGetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.
void
ifIsSetterMethod(String template, Properties attributes)
TODO: There is a big overlap here with stuff in ejb - have a look.
String
indexedConstructorParamValue(Properties attributes)
Describe what the method does
String
indexedMethodParamValue(Properties attributes)
protected boolean
isGetterMethod()
protected boolean
isSetterMethod()
String
mbeanName()
Returns the MBean name for the current class.

Methods inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler

checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMemberTagTokens, forAllMemberTags, forAllMembers, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember, hasExecutableMember_OLD, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken

Methods inherited from class xdoclet.XDocletTagSupport

delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Methods inherited from class xdoclet.template.TemplateTagHandler

getXJavaDoc, setXJavaDoc

Field Details

attributes

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

handler

protected xdoclet.tagshandler.MethodTagsHandler handler
For use in extracting method names.

index

protected int index
For looping through indexed tags.

Method Details

constructorSignature

public String constructorSignature()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

forAllIndexedConstructorParams

public void forAllIndexedConstructorParams(String template,
                                           Properties attributes)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
attributes - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

forAllIndexedMethodParams

public void forAllIndexedMethodParams(String template,
                                      Properties attributes)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
attributes - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

getMBeanName

protected String getMBeanName(XClass clazz)
            throws xdoclet.XDocletException
Parameters:
clazz -
Returns:
Description of the Returned Value
Throws:
xdoclet.XDocletException - Description of Exception

ifHasAttributeDescription

public void ifHasAttributeDescription(String template,
                                      Properties attributes)
            throws xdoclet.XDocletException
Parameters:
template -
attributes -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifIsGetterMethod

public void ifIsGetterMethod(String template,
                             Properties attributes)
            throws xdoclet.XDocletException
TODO: There is a big overlap here with stuff in ejb - have a look.
Parameters:
template -
attributes -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block" description = "Executes the block if the current method is a getter"

ifIsSetterMethod

public void ifIsSetterMethod(String template,
                             Properties attributes)
            throws xdoclet.XDocletException
TODO: There is a big overlap here with stuff in ejb - have a look.
Parameters:
template -
attributes -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block" description = "Executes the block if the current method is a setter"

indexedConstructorParamValue

public String indexedConstructorParamValue(Properties attributes)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
attributes - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

indexedMethodParamValue

public String indexedMethodParamValue(Properties attributes)
            throws xdoclet.XDocletException
Parameters:
attributes - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception
To do:
refactor common code with indexedConstructorParamValue into a private method

isGetterMethod

protected boolean isGetterMethod()
Returns:
The GetterMethod value
To do:
(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
To do:
(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()
            throws xdoclet.XDocletException
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:
xdoclet.XDocletException - Description of Exception
doc.tag
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."