xdoclet.modules.externalizer
Class ExternalizerSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.modules.externalizer.ExternalizerSubTask
All Implemented Interfaces:
java.io.Serializable

public class ExternalizerSubTask
extends 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 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)
See Also:
Serialized Form
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 java.lang.String GENERATED_FILE_NAME
           
 
Fields inherited from class xdoclet.DocletSupport
currentClassTag, currentFieldTag, currentMethodTag
 
Constructor Summary
ExternalizerSubTask()
           
 
Method Summary
protected  void generateForClass(xjavadoc.XClass clazz)
          Processed template for clazz and generates output file for clazz.
protected  java.lang.String getBundleKey(xjavadoc.XClass clazz)
           
 xdoclet.modules.externalizer.ExternalizerSubTask.Combination getCurrentCombination()
           
protected  java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
          Returns the filename of the generated file for a class.
 java.lang.String getKeyParamName()
           
 java.lang.String getTagName()
           
 java.lang.String getValueParamName()
           
 void setKeyParamName(java.lang.String p)
           
 void setTagName(java.lang.String tagName)
           
 void setValueParamName(java.lang.String valueParamName)
           
 void validateOptions()
          Called to validate configuration parameters.
 
Methods inherited from class xdoclet.TemplateSubTask
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, 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
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GENERATED_FILE_NAME

public static final java.lang.String GENERATED_FILE_NAME
See Also:
Constant Field Values
Constructor Detail

ExternalizerSubTask

public ExternalizerSubTask()
Method Detail

getTagName

public java.lang.String getTagName()

getValueParamName

public java.lang.String getValueParamName()

getCurrentCombination

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

getKeyParamName

public java.lang.String getKeyParamName()

setTagName

public void setTagName(java.lang.String tagName)

setValueParamName

public void setValueParamName(java.lang.String valueParamName)

setKeyParamName

public void setKeyParamName(java.lang.String p)

validateOptions

public void validateOptions()
                     throws XDocletException
Description copied from class: TemplateSubTask
Called to validate configuration parameters.

Overrides:
validateOptions in class TemplateSubTask
Throws:
XDocletException - Description of Exception

getBundleKey

protected java.lang.String getBundleKey(xjavadoc.XClass clazz)

getGeneratedFileName

protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
                                         throws XDocletException
Description copied from class: TemplateSubTask
Returns the filename of the generated file for a class. If the string "{0}" is present in the pattern, it will be substituted with the transformed class name.

Overrides:
getGeneratedFileName in class TemplateSubTask
Parameters:
clazz - the class being processed
Returns:
the corresponding filename
Throws:
XDocletException - Description of Exception

generateForClass

protected void generateForClass(xjavadoc.XClass clazz)
                         throws XDocletException
Description copied from class: TemplateSubTask
Processed template for clazz and generates output file for clazz.

Overrides:
generateForClass in class TemplateSubTask
Parameters:
clazz - Description of Parameter
Throws:
XDocletException - Description of Exception

http://xdoclet.sourceforge.net/