xdoclet.jmx.tags
Class JMXTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.tags.AbstractProgramElementTagsHandler
                    |
                    +--xdoclet.jmx.tags.JMXTagsHandler

public class JMXTagsHandler

extends AbstractProgramElementTagsHandler

Version:

$Revision: 1.5 $

Author:

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

Field Summary

protected java.util.Map	attributes Collection of attributes.
protected MethodTagsHandler	handler For use in extracting method names.
protected int	index For looping through indexed tags.

Fields inherited from class xdoclet.tags.AbstractProgramElementTagsHandler

currentToken, matchPattern, tagTokenizer

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

JMXTagsHandler()

Method Summary

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

Methods inherited from class xdoclet.tags.AbstractProgramElementTagsHandler

checkForWrap, currentToken, exceptionList, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getExecutableMemberDocForMemberName, getExecutableMemberDocForMemberName, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, hasExecutableMember, ifHasTag_Impl, ifTagValueEquals_Impl, matchValue, memberComment, setMatchValue, skipToken

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handler

protected MethodTagsHandler handler

For use in extracting method names.

attributes

protected java.util.Map attributes

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

index

protected int index

For looping through indexed tags.

Constructor Detail

JMXTagsHandler

public JMXTagsHandler()

Method Detail

mbeanName

public java.lang.String mbeanName()
                           throws 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:

XDocletException - Description of Exception

See Also:

getMBeanName(com.sun.javadoc.ClassDoc)

ifIsGetterMethod

public void ifIsGetterMethod(java.lang.String template,
                             java.util.Properties attributes)
                      throws XDocletException

TODO: There is a big overlap here with stuff in ejb - have a look.

Parameters:

template -

attributes -

Throws:

XDocletException -

ifIsSetterMethod

public void ifIsSetterMethod(java.lang.String template,
                             java.util.Properties attributes)
                      throws XDocletException

TODO: There is a big overlap here with stuff in ejb - have a look.

Parameters:

template -

attributes -

Throws:

XDocletException -

ifHasAttributeDescription

public void ifHasAttributeDescription(java.lang.String template,
                                      java.util.Properties attributes)
                               throws XDocletException

Parameters:

template -

attributes -

Throws:

XDocletException -

forAllIndexedMethodParams

public void forAllIndexedMethodParams(java.lang.String template,
                                      java.util.Properties attributes)
                               throws XDocletException

forAllIndexedConstructorParams

public void forAllIndexedConstructorParams(java.lang.String template,
                                           java.util.Properties attributes)
                                    throws XDocletException

indexedMethodParamValue

public java.lang.String indexedMethodParamValue(java.util.Properties attributes)
                                         throws XDocletException

indexedConstructorParamValue

public java.lang.String indexedConstructorParamValue(java.util.Properties attributes)
                                              throws XDocletException

constructorSignature

public java.lang.String constructorSignature()
                                      throws XDocletException

getMBeanName

protected java.lang.String getMBeanName(com.sun.javadoc.ClassDoc clazz)
                                 throws XDocletException

Implementation of mbeanName().

Parameters:

clazz -

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

isGetterMethod

protected boolean isGetterMethod()

isSetterMethod

protected boolean isSetterMethod()