xdoclet.tagshandler

Class MethodTagsHandler


public class MethodTagsHandler
extends xdoclet.tagshandler.AbstractProgramElementTagsHandler

Field Summary

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
currentMethodName()
String
exceptionList(Properties attributes)
void
executeAndRestoreMethod(String template, Properties attributes)
String
firstSentenceDescriptionOfCurrentMethod()
void
forAllClassMethods(String template, Properties attributes)
void
forAllMethodTagTokens(String template, Properties attributes)
void
forAllMethodTags(String template, Properties attributes)
void
forAllMethods(String template, Properties attributes)
static String
getMethodNameWithoutPrefixFor(XMethod currentMethod)
static String
getMethodTypeFor(XMethod method)
static String
getPropertyNameFor(XMethod method)
static String
getTransformedMethodTypeFor(XMethod method)
String
getterMethod()
String
getterPrefix()
static boolean
hasMethod(XClass clazz, String methodName, String[] parameters, boolean setCurrentMethod)
void
ifDoesntHaveMethod(String template, Properties attributes)
void
ifDoesntHaveMethodTag(String template, Properties attributes)
void
ifDoesntReturnVoid(String template, Properties attributes)
void
ifDoesntThrowException(String template, Properties attributes)
void
ifHasMethod(String template, Properties attributes)
void
ifHasMethodComment(String template)
void
ifHasMethodTag(String template, Properties attributes)
void
ifIsAbstract(String template, Properties attributes)
void
ifIsGetter(String template, Properties attributes)
void
ifIsNotAbstract(String template, Properties attributes)
void
ifIsNotOfType(String template, Properties attributes)
void
ifIsOfType(String template, Properties attributes)
boolean
ifIsOfTypeImpl(String template, Properties attributes)
void
ifIsPublic(String template)
void
ifIsSetter(String template, Properties attributes)
void
ifMethodNameEquals(String template, Properties attributes)
void
ifMethodNameNotEquals(String template, Properties attributes)
void
ifMethodTagValueEquals(String template, Properties attributes)
void
ifMethodTagValueNotEquals(String template, Properties attributes)
void
ifReturnsVoid(String template, Properties attributes)
void
ifThrowsException(String template, Properties attributes)
static boolean
isGetter(String str)
static boolean
isGetterMethod(XMethod method)
static boolean
isSetter(String str)
static boolean
isSetterMethod(XMethod method)
String
methodComment(Properties attributes)
String
methodName(Properties attributes)
String
methodNameWithoutPrefix()
String
methodTagValue(Properties attributes)
String
methodType(Properties attributes)
String
modifiers()
String
propertyName()
void
setCurrentMethod(String template, Properties attributes)
String
setterMethod()
String
transformedMethodType(Properties attributes)

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

Method Details

currentMethodName

public String currentMethodName()
            throws xdoclet.XDocletException

exceptionList

public String exceptionList(Properties attributes)
            throws xdoclet.XDocletException

executeAndRestoreMethod

public void executeAndRestoreMethod(String template,
                                    Properties attributes)
            throws xdoclet.XDocletException

firstSentenceDescriptionOfCurrentMethod

public String firstSentenceDescriptionOfCurrentMethod()
            throws xdoclet.XDocletException

forAllClassMethods

public void forAllClassMethods(String template,
                               Properties attributes)
            throws xdoclet.XDocletException

forAllMethodTagTokens

public void forAllMethodTagTokens(String template,
                                  Properties attributes)
            throws xdoclet.XDocletException

forAllMethodTags

public void forAllMethodTags(String template,
                             Properties attributes)
            throws xdoclet.XDocletException

forAllMethods

public void forAllMethods(String template,
                          Properties attributes)
            throws xdoclet.XDocletException

getMethodNameWithoutPrefixFor

public static String getMethodNameWithoutPrefixFor(XMethod currentMethod)

getMethodTypeFor

public static String getMethodTypeFor(XMethod method)

getPropertyNameFor

public static String getPropertyNameFor(XMethod method)

getTransformedMethodTypeFor

public static String getTransformedMethodTypeFor(XMethod method)

getterMethod

public String getterMethod()
            throws xdoclet.XDocletException

getterPrefix

public String getterPrefix()
            throws xdoclet.XDocletException

hasMethod

public static boolean hasMethod(XClass clazz,
                                String methodName,
                                String[] parameters,
                                boolean setCurrentMethod)
            throws xdoclet.XDocletException

ifDoesntHaveMethod

public void ifDoesntHaveMethod(String template,
                               Properties attributes)
            throws xdoclet.XDocletException

ifDoesntHaveMethodTag

public void ifDoesntHaveMethodTag(String template,
                                  Properties attributes)
            throws xdoclet.XDocletException

ifDoesntReturnVoid

public void ifDoesntReturnVoid(String template,
                               Properties attributes)
            throws xdoclet.XDocletException

ifDoesntThrowException

public void ifDoesntThrowException(String template,
                                   Properties attributes)
            throws xdoclet.XDocletException

ifHasMethod

public void ifHasMethod(String template,
                        Properties attributes)
            throws xdoclet.XDocletException

ifHasMethodComment

public void ifHasMethodComment(String template)
            throws xdoclet.XDocletException

ifHasMethodTag

public void ifHasMethodTag(String template,
                           Properties attributes)
            throws xdoclet.XDocletException

ifIsAbstract

public void ifIsAbstract(String template,
                         Properties attributes)
            throws xdoclet.XDocletException

ifIsGetter

public void ifIsGetter(String template,
                       Properties attributes)
            throws xdoclet.XDocletException

ifIsNotAbstract

public void ifIsNotAbstract(String template,
                            Properties attributes)
            throws xdoclet.XDocletException

ifIsNotOfType

public void ifIsNotOfType(String template,
                          Properties attributes)
            throws xdoclet.XDocletException

ifIsOfType

public void ifIsOfType(String template,
                       Properties attributes)
            throws xdoclet.XDocletException

ifIsOfTypeImpl

public boolean ifIsOfTypeImpl(String template,
                              Properties attributes)
            throws xdoclet.XDocletException

ifIsPublic

public void ifIsPublic(String template)
            throws xdoclet.XDocletException

ifIsSetter

public void ifIsSetter(String template,
                       Properties attributes)
            throws xdoclet.XDocletException

ifMethodNameEquals

public void ifMethodNameEquals(String template,
                               Properties attributes)
            throws xdoclet.XDocletException

ifMethodNameNotEquals

public void ifMethodNameNotEquals(String template,
                                  Properties attributes)
            throws xdoclet.XDocletException

ifMethodTagValueEquals

public void ifMethodTagValueEquals(String template,
                                   Properties attributes)
            throws xdoclet.XDocletException

ifMethodTagValueNotEquals

public void ifMethodTagValueNotEquals(String template,
                                      Properties attributes)
            throws xdoclet.XDocletException

ifReturnsVoid

public void ifReturnsVoid(String template,
                          Properties attributes)
            throws xdoclet.XDocletException

ifThrowsException

public void ifThrowsException(String template,
                              Properties attributes)
            throws xdoclet.XDocletException

isGetter

public static boolean isGetter(String str)

isGetterMethod

public static boolean isGetterMethod(XMethod method)

isSetter

public static boolean isSetter(String str)

isSetterMethod

public static boolean isSetterMethod(XMethod method)

methodComment

public String methodComment(Properties attributes)
            throws xdoclet.XDocletException

methodName

public String methodName(Properties attributes)
            throws xdoclet.XDocletException

methodNameWithoutPrefix

public String methodNameWithoutPrefix()
            throws xdoclet.XDocletException

methodTagValue

public String methodTagValue(Properties attributes)
            throws xdoclet.XDocletException

methodType

public String methodType(Properties attributes)
            throws xdoclet.XDocletException

modifiers

public String modifiers()
            throws xdoclet.XDocletException

propertyName

public String propertyName()
            throws xdoclet.XDocletException

setCurrentMethod

public void setCurrentMethod(String template,
                             Properties attributes)
            throws xdoclet.XDocletException

setterMethod

public String setterMethod()
            throws xdoclet.XDocletException

transformedMethodType

public String transformedMethodType(Properties attributes)
            throws xdoclet.XDocletException