xdoclet.modules.externalizer

Class ExternalizerTagsHandler


public class ExternalizerTagsHandler
extends xdoclet.XDocletTagSupport

Tags used in generating & using externalised property resource bundles.
Version:
$Revision: 1.7 $
Author:
Ara Abrahamian (ara_e_w@yahoo.com)
xdoclet.taghandler
namespace = "Externalizer"
created
May 30, 2002

Field Summary

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Method Summary

String
bundleKey()
Current resource bundle name, will be called by propertiestranslator subtask.
void
forAllFieldTags(String template)
Evaluate the body for all field tags.
String
key()
The current key.
String
value()
The current value, with Unicode escapes where necessary.

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

bundleKey

public String bundleKey()
            throws xdoclet.XDocletException
Current resource bundle name, will be called by propertiestranslator subtask.
Returns:
bundle name
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

forAllFieldTags

public void forAllFieldTags(String template)
            throws xdoclet.XDocletException
Evaluate the body for all field tags. Works only in context of externalizer subtask.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

key

public String key()
            throws xdoclet.XDocletException
The current key.
Returns:
key
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

value

public String value()
            throws xdoclet.XDocletException
The current value, with Unicode escapes where necessary.
Returns:
value
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"