xdoclet.modules.ejb.mdb

Class MdbSubTask


public class MdbSubTask
extends AbstractEjbCodeGeneratorSubTask

Version:
$Revision: 1.2 $
Author:
Jonathan Kovacs (jonk at globaliqx.com)
ant.element
display-name = "Mdb Bean" name = "mdb" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Sept 15, 2003

Field Summary

static String
DEFAULT_MESSAGE_DRIVEN_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
mdbClassPattern
A configuration parameter for specifying the concrete mdb bean class name pattern.

Constructor Summary

MdbSubTask()
Describe what the MdbSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the MdbSubTask object
String
getMessageDrivenClassPattern()
Returns the configuration parameter for specifying the concrete mdb bean class name pattern.
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setPattern(String new_pattern)
Sets the Pattern attribute of the MdbSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

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.

Constructor Details

MdbSubTask

public MdbSubTask()
Describe what the MdbSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
xdoclet.XDocletException -

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the MdbSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.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

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.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()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -