xdoclet.tags
Class PropertyTagsHandler

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

public class PropertyTagsHandler

extends AbstractProgramElementTagsHandler

PropertyTagsHandler.java

Version:

$$

Author:

David Jencks

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

PropertyTagsHandler()

Method Summary

void	forAllPropertiesWithTag(java.lang.String template, java.util.Properties attributes) Evaluates the body block for each managed attribute of current mbean.You may set whether superclasses are examined also with the superclass attribute.
protected com.sun.javadoc.MethodDoc	getMethodDocForMethodName(java.lang.String methodName) Searches for the MethodDoc of the method with name methodName and returns it.
void	ifHasGetMethodWithTag(java.lang.String template, java.util.Properties attributes) The block tag ifHasGetMethod looks for a get method based on the attribute name from the current method, sets the current method to that get method, and applies the template if found.
void	ifHasSetMethodWithTag(java.lang.String template, java.util.Properties attributes) The block tag ifHasSetMethod looks for a set method based on the attribute name from the current method, sets the current method to that set method, and applies the template if found.
java.lang.String	propertyTypeWithTag(java.util.Properties attributes) The propertyTypeWithTag method figures out the type for the current property with tag by looking for a getter, then a setter.

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

Constructor Detail

PropertyTagsHandler

public PropertyTagsHandler()

Method Detail

forAllPropertiesWithTag

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

Evaluates the body block for each managed attribute of current mbean.You may set whether superclasses are examined also with the superclass attribute. Finds attributes with getter, setter, or both. The getter and setter should have javabean naming convention. (david jencks)

Parameters:

template - The body of the block tag

attributes -

Throws:

XDocletException - Description of Exception

ifHasGetMethodWithTag

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

The block tag ifHasGetMethod looks for a get method based on the attribute name from the current method, sets the current method to that get method, and applies the template if found. This is used to look for getters for mbean managed attributes. The get method found may be the current method.

Parameters:

template - a String value

attributes - a Properties value

Throws:

XDocletException - if an error occurs

ifHasSetMethodWithTag

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

The block tag ifHasSetMethod looks for a set method based on the attribute name from the current method, sets the current method to that set method, and applies the template if found. This is used to look for setters for mbean managed attributes. The set method found may be the current method.

Parameters:

template - a String value

attributes - a Properties value

Throws:

XDocletException - if an error occurs

propertyTypeWithTag

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

The propertyTypeWithTag method figures out the type for the current property with tag by looking for a getter, then a setter.

Parameters:

attributes - a Properties value including the tagName required.

Returns:

the String fully qualified name of the property type.

Throws:

XDocletException - if an error occurs

getMethodDocForMethodName

protected com.sun.javadoc.MethodDoc getMethodDocForMethodName(java.lang.String methodName)

Searches for the MethodDoc of the method with name methodName and returns it. Copied from MethodTagsHandler

Parameters:

methodName - Description of Parameter

Returns:

The MethodDocForMethodName value