xdoclet.modules.java.javabean

Class BeanInfoSubTask

Implemented Interfaces:
Serializable

public class BeanInfoSubTask
extends xdoclet.TemplateSubTask

Generate the BeanInfo class for a given JavaBean class, and an optional messages properties bundle to go with it.
Version:
$Revision: 1.6 $
Author:
Laurent Etiemble (letiemble@users.sourceforge.net)
ant.element
name = "beaninfo" display-name = "BeanInfo Class" parent = "xdoclet.DocletTask"
created
June 20, 2002

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

static String
GENERATED_BEANINFO_CLASS_NAME
Pattern for generation of BeanInfo files
static String
GENERATED_BEANINFO_FILE_NAME
Pattern for generation of BeanInfo files
protected boolean
i18nGeneration
Is the BeanInfo class built for I18N

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

BeanInfoSubTask()
Constructor for the BeanInfoSubTask object

Method Summary

protected void
engineStarted()
Called when the engine is started
void
execute()
protected String
getGeneratedFileName(XClass clazz)
boolean
isI18n()
Get whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
void
setI18n(boolean value)
Set whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
void
validateOptions()
Called to validate configuration parameters.

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_BEANINFO_CLASS_NAME

public static String GENERATED_BEANINFO_CLASS_NAME
Pattern for generation of BeanInfo files

GENERATED_BEANINFO_FILE_NAME

public static String GENERATED_BEANINFO_FILE_NAME
Pattern for generation of BeanInfo files

i18nGeneration

protected boolean i18nGeneration
Is the BeanInfo class built for I18N

Constructor Details

BeanInfoSubTask

public BeanInfoSubTask()
Constructor for the BeanInfoSubTask object

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Called when the engine is started
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Thrown in case of problem

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Description of Exception

getGeneratedFileName

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

isI18n

public boolean isI18n()
Get whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
Returns:
true if I18N is supported

setI18n

public void setI18n(boolean value)
Set whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
Parameters:
value - true to support I18N

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Description of Exception