xdoclet.modules.java.javabean

Class BeanInfoSubTask

public class BeanInfoSubTask extends 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)

UNKNOWN: June 20, 2002 name = "beaninfo" display-name = "BeanInfo Class" parent = "xdoclet.DocletTask"

Field Summary
static StringGENERATED_BEANINFO_CLASS_NAME
Pattern for generation of BeanInfo files
static StringGENERATED_BEANINFO_FILE_NAME
Pattern for generation of BeanInfo files
protected booleani18nGeneration
Is the BeanInfo class built for I18N
Constructor Summary
BeanInfoSubTask()
Constructor for the BeanInfoSubTask object
Method Summary
protected voidengineStarted()
Called when the engine is started
voidexecute()
protected StringgetGeneratedFileName(XClass clazz)
booleanisI18n()
Get whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
voidsetI18n(boolean value)
Set whether or not a I18N resource bundle will be generated, and the BeanInfo classes will use it
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

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 Detail

BeanInfoSubTask

public BeanInfoSubTask()
Constructor for the BeanInfoSubTask object

Method Detail

engineStarted

protected void engineStarted()
Called when the engine is started

Throws: XDocletException Thrown in case of problem

execute

public void execute()

Throws: XDocletException Description of Exception

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)

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()
Called to validate configuration parameters.

Throws: XDocletException Description of Exception