xdoclet.modules.externalizer

Class ExternalizerSubTask

Implemented Interfaces:
Serializable

public class ExternalizerSubTask
extends xdoclet.TemplateSubTask

Externalizes key-value paired tags to whatever configured file (be it xml or properties file). It's useful for simple key-value properties or xml files. For now only properties files are supported. It supports i18n and l10n, so generated files follow java.util.ResourceBundle naming convention. Parameters "language", "country" and "variant" are reserved and used for this purpose.
Version:
$Revision: 1.12 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "Externalizer" name = "externalizer" parent = "xdoclet.DocletTask"
created
May 7, 2002

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

static String
GENERATED_FILE_NAME

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

ExternalizerSubTask()

Method Summary

protected void
generateForClass(XClass clazz)
protected String
getBundleKey(XClass clazz)
xdoclet.modules.externalizer.ExternalizerSubTask.Combination
getCurrentCombination()
protected String
getGeneratedFileName(XClass clazz)
String
getKeyParamName()
String
getTagName()
String
getValueParamName()
void
setKeyParamName(String p)
void
setTagName(String tagName)
void
setValueParamName(String valueParamName)
void
validateOptions()

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Field Details

GENERATED_FILE_NAME

public static final String GENERATED_FILE_NAME

Constructor Details

ExternalizerSubTask

public ExternalizerSubTask()

Method Details

generateForClass

protected void generateForClass(XClass clazz)
            throws xdoclet.XDocletException
Overrides:
generateForClass in interface xdoclet.TemplateSubTask

getBundleKey

protected String getBundleKey(XClass clazz)

getCurrentCombination

public xdoclet.modules.externalizer.ExternalizerSubTask.Combination getCurrentCombination()

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask

getKeyParamName

public String getKeyParamName()

getTagName

public String getTagName()

getValueParamName

public String getValueParamName()

setKeyParamName

public void setKeyParamName(String p)

setTagName

public void setTagName(String tagName)

setValueParamName

public void setValueParamName(String valueParamName)

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.TemplateSubTask