xdoclet.modules.apache

Class ScriptEngineTagHandler

Known Direct Subclasses:
BsfEngineTagHandler, VelocityEngineTagHandler

public abstract class ScriptEngineTagHandler
extends xdoclet.tagshandler.AbstractProgramElementTagsHandler

created
July 17, 2003

Field Summary

protected String
XDTSectionEnd
protected String
XDTSectionStart

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

protected void
escapeResults(xdoclet.template.TemplateEngine engine, StringBuffer results)
Escape and evaluate the sections with XDOCLET template engine.
protected void
fillVariables(SubTemplateEngine templateEngine)
Fill the variables passed to the engines
protected void
generate(SubTemplateEngine subengine, String template, Properties attributes)
protected String
getSubTemplateVariable(SubTemplateEngine subengine, Properties attributes)
Get a subtemplate variable

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

XDTSectionEnd

protected final String XDTSectionEnd

XDTSectionStart

protected final String XDTSectionStart

Method Details

escapeResults

protected final void escapeResults(xdoclet.template.TemplateEngine engine,
                                   StringBuffer results)
            throws xdoclet.template.TemplateException
Escape and evaluate the sections with XDOCLET template engine. This allows embedding XDOCLET sections into Velocity sections
Parameters:
engine - The XDOCLET template engine
results - The results
Throws:
xdoclet.template.TemplateException -

fillVariables

protected final void fillVariables(SubTemplateEngine templateEngine)
            throws xdoclet.XDocletException
Fill the variables passed to the engines
Parameters:
templateEngine -
Throws:
xdoclet.XDocletException -

generate

protected final void generate(SubTemplateEngine subengine,
                              String template,
                              Properties attributes)
            throws xdoclet.template.TemplateException
Parameters:
subengine - The SubTemplateEngine used to generate
template - The body of the block tag
attributes - The attributes of the template tag
Throws:
xdoclet.template.TemplateException -
xdoclet.template.TemplateException -

getSubTemplateVariable

protected final String getSubTemplateVariable(SubTemplateEngine subengine,
                                              Properties attributes)
            throws xdoclet.XDocletException
Get a subtemplate variable
Parameters:
subengine - The subtemplate engine
attributes - The attributes from XDOCLET tag
Returns:
The value
Throws:
xdoclet.XDocletException -