xdoclet.tagshandler

Class ClassTagsHandler


public class ClassTagsHandler
extends xdoclet.tagshandler.AbstractProgramElementTagsHandler

Field Summary

protected static DateFormat
dateFormatter
protected static Calendar
now

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
classComment(Properties attributes)
String
classCommentTags(Properties attributes)
String
classCommentText(Properties attributes)
String
className()
void
classOf(String template)
String
classTagValue(Properties attributes)
String
classTagValueMatch(Properties attributes)
String
firstSentenceDescription(Properties attributes)
void
forAllClassTagTokens(String template, Properties attributes)
void
forAllClassTags(String template, Properties attributes)
void
forAllClasses(String template, Properties attributes)
void
forAllDistinctClassTags(String template, Properties attributes)
static void
forAllDistinctClassTags(xdoclet.template.TemplateEngine engine, String template, String tagName, String paramName)
String
fullClassName()
String
fullSuperclassName()
String
fullTransformedClassName()
static String
getClassNameFor(XClass clazz)
static String
getFullClassNameFor(XClass clazz)
void
ifClassTagValueEquals(String template, Properties attributes)
void
ifClassTagValueMatches(String template, Properties attributes)
void
ifClassTagValueNotEquals(String template, Properties attributes)
void
ifDoesntHaveClassTag(String template, Properties attributes)
void
ifHasClassTag(String template, Properties attributes)
void
ifIsClassAbstract(String template)
void
ifIsClassNotAbstract(String template)
String
importedList(Properties attributes)
String
modifiers()
void
pushClass(String template, Properties attributes)
String
symbolicClassName()
String
transformedClassName()

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

dateFormatter

protected static final DateFormat dateFormatter

now

protected static final Calendar now

Method Details

classComment

public String classComment(Properties attributes)
            throws xdoclet.XDocletException

classCommentTags

public String classCommentTags(Properties attributes)
            throws xdoclet.XDocletException

classCommentText

public String classCommentText(Properties attributes)
            throws xdoclet.XDocletException

className

public String className()
            throws xdoclet.XDocletException

classOf

public void classOf(String template)
            throws xdoclet.XDocletException

classTagValue

public String classTagValue(Properties attributes)
            throws xdoclet.XDocletException

classTagValueMatch

public String classTagValueMatch(Properties attributes)
            throws xdoclet.XDocletException

firstSentenceDescription

public String firstSentenceDescription(Properties attributes)
            throws xdoclet.XDocletException

forAllClassTagTokens

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

forAllClassTags

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

forAllClasses

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

forAllDistinctClassTags

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

forAllDistinctClassTags

public static void forAllDistinctClassTags(xdoclet.template.TemplateEngine engine,
                                           String template,
                                           String tagName,
                                           String paramName)
            throws xdoclet.XDocletException

fullClassName

public String fullClassName()
            throws xdoclet.XDocletException

fullSuperclassName

public String fullSuperclassName()
            throws xdoclet.XDocletException

fullTransformedClassName

public String fullTransformedClassName()
            throws xdoclet.XDocletException

getClassNameFor

public static String getClassNameFor(XClass clazz)
Overrides:
getClassNameFor in interface xdoclet.tagshandler.AbstractProgramElementTagsHandler

getFullClassNameFor

public static String getFullClassNameFor(XClass clazz)
Overrides:
getFullClassNameFor in interface xdoclet.tagshandler.AbstractProgramElementTagsHandler

ifClassTagValueEquals

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

ifClassTagValueMatches

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

ifClassTagValueNotEquals

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

ifDoesntHaveClassTag

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

ifHasClassTag

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

ifIsClassAbstract

public void ifIsClassAbstract(String template)
            throws xdoclet.XDocletException

ifIsClassNotAbstract

public void ifIsClassNotAbstract(String template)
            throws xdoclet.XDocletException

importedList

public String importedList(Properties attributes)
            throws xdoclet.XDocletException

modifiers

public String modifiers()
            throws xdoclet.XDocletException

pushClass

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

symbolicClassName

public String symbolicClassName()
            throws xdoclet.XDocletException

transformedClassName

public String transformedClassName()
            throws xdoclet.XDocletException