xdoclet.modules.ejb.mdb

Class MdbSubTask

public class MdbSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.2 $

Author: Jonathan Kovacs (jonk at globaliqx.com)

UNKNOWN: Sept 15, 2003 display-name = "Mdb Bean" name = "mdb" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "mdb-custom.xdt" relates-to = "{0}Mdb.java" description = "A text file containing custom * template and/or java code to include in the EJB mdb class."

Field Summary
static StringDEFAULT_MESSAGE_DRIVEN_CLASS_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringmdbClassPattern
A configuration parameter for specifying the concrete mdb bean class name pattern.
Constructor Summary
MdbSubTask()
Describe what the MdbSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the MdbSubTask object
StringgetMessageDrivenClassPattern()
Returns the configuration parameter for specifying the concrete mdb bean class name pattern.
protected booleanmatchesGenerationRules(XClass clazz)
Describe what the method does
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the MdbSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

DEFAULT_MESSAGE_DRIVEN_CLASS_PATTERN

public static final String DEFAULT_MESSAGE_DRIVEN_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

mdbClassPattern

protected String mdbClassPattern
A configuration parameter for specifying the concrete mdb bean class name pattern. By default the value is used for deciding the concrete mdb bean class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

See Also: getMessageDrivenClassPattern

Constructor Detail

MdbSubTask

public MdbSubTask()
Describe what the MdbSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the MdbSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

getMessageDrivenClassPattern

public String getMessageDrivenClassPattern()
Returns the configuration parameter for specifying the concrete mdb bean class name pattern. By default the value is used for deciding the concrete mdb bean class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}Mdb" is used by default.

Returns: The MdbClassPattern value

See Also: mdbClassPattern

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
Describe what the method does

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

setPattern

public void setPattern(String new_pattern)
Sets the Pattern attribute of the MdbSubTask object

Parameters: new_pattern The new Pattern value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException