xdoclet.tagshandler

Class FieldTagsHandler


public class FieldTagsHandler
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
fieldComment(Properties attributes)
String
fieldName()
String
fieldTagValue(Properties attributes)
String
fieldType()
String
firstSentenceDescriptionOfCurrentField()
void
forAllFieldTagTokens(String template, Properties attributes)
void
forAllFieldTags(String template, Properties attributes)
void
forAllFields(String template, Properties attributes)
String
getCapitalizedFieldName()
static String
getFieldTypeFor(XField field)
void
ifDoesntHaveFieldTag(String template, Properties attributes)
void
ifFieldTagValueEquals(String template, Properties attributes)
void
ifHasFieldTag(String template, Properties attributes)
String
modifiers()

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

fieldComment

public String fieldComment(Properties attributes)
            throws xdoclet.XDocletException

fieldName

public String fieldName()
            throws xdoclet.XDocletException

fieldTagValue

public String fieldTagValue(Properties attributes)
            throws xdoclet.XDocletException

fieldType

public String fieldType()
            throws xdoclet.XDocletException

firstSentenceDescriptionOfCurrentField

public String firstSentenceDescriptionOfCurrentField()
            throws xdoclet.XDocletException

forAllFieldTagTokens

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

forAllFieldTags

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

forAllFields

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

getCapitalizedFieldName

public String getCapitalizedFieldName()
            throws xdoclet.XDocletException

getFieldTypeFor

public static String getFieldTypeFor(XField field)
            throws xdoclet.XDocletException

ifDoesntHaveFieldTag

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

ifFieldTagValueEquals

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

ifHasFieldTag

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

modifiers

public String modifiers()
            throws xdoclet.XDocletException