xdoclet.modules.apache.bsf
Class BsfEngineTagHandler

java.lang.Object
  xdoclet.template.TemplateTagHandler
      xdoclet.XDocletTagSupport
          xdoclet.tagshandler.AbstractProgramElementTagsHandler
              xdoclet.modules.apache.ScriptEngineTagHandler
                  xdoclet.modules.apache.bsf.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

Constructor Summary

BsfEngineTagHandler()

Method Summary

void	clearVariables() Clear all BSF variables
void	generator(java.lang.String template, java.util.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.
java.lang.String	getVariable(java.util.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, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BsfEngineTagHandler

public BsfEngineTagHandler()

Method Detail

getVariable

public java.lang.String getVariable(java.util.Properties attributes)
                             throws XDocletException

Get a value of a BSF variable

Parameters:

attributes -

Returns:

Throws:

XDocletException

doc.tag

type = "content"

generator

public void generator(java.lang.String template,
                      java.util.Properties attributes)
               throws 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:

TemplateException

doc.tag

type = "block"

clearVariables

public void clearVariables()
                    throws XDocletException

Clear all BSF variables

Throws:

XDocletException

doc.tag

type = "content"