Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

xdoclet.modules.apache.bsf

Class BsfEngineTagHandler

public class BsfEngineTagHandler
extends ScriptEngineTagHandler
This is a tag handler able to execute BSF engine on a block!
Author:
zluspai
xdoclet.taghandler
namespace = "Bsf"
created
July 16, 2003

Field Summary

Fields inherited from class xdoclet.modules.apache.ScriptEngineTagHandler

XDTSectionEnd, 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

void
clearVariables()
Clear all BSF variables
void
generator(String template, Properties attributes)
Evaluates the body block with the BSF script If the silent="yes" attribute is set then the Generator will not produce any output, but the template will run.
String
getVariable(Properties attributes)
Get a value of a BSF variable

Methods inherited from class xdoclet.modules.apache.ScriptEngineTagHandler

escapeResults, fillVariables, generate, getSubTemplateVariable

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

clearVariables

public void clearVariables()
            throws xdoclet.XDocletException
Clear all BSF variables
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

generator

public void generator(String template,
                      Properties attributes)
            throws xdoclet.template.TemplateException
Evaluates the body block with the BSF script If the silent="yes" attribute is set then the Generator will not produce any output, but the template will run. If the disable="yes" attribute is set then the Velocity template will not run at all.
Parameters:
template - The body of the block tag
attributes - The attributes of the template tag
Throws:
xdoclet.template.TemplateException -
doc.tag
type = "block"

getVariable

public String getVariable(Properties attributes)
            throws xdoclet.XDocletException
Get a value of a BSF variable
Parameters:
attributes -
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

Overview Package Class Use Tree Index Deprecated About
http://xdoclet.sourceforge.net/