xdoclet.modules.ejb.session

Class SessionSubTask


public class SessionSubTask
extends AbstractEjbCodeGeneratorSubTask

Version:
$Revision: 1.8 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "Session Bean" name = "session" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Field Summary

static String
DEFAULT_SESSION_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
sessionClassPattern
A configuration parameter for specifying the concrete session bean class name pattern.

Constructor Summary

SessionSubTask()
Describe what the SessionSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the SessionSubTask object
String
getSessionClassPattern()
Returns the configuration parameter for specifying the concrete session 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 SessionSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

DEFAULT_SESSION_CLASS_PATTERN

public static final String DEFAULT_SESSION_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

sessionClassPattern

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

Constructor Details

SessionSubTask

public SessionSubTask()
Describe what the SessionSubTask 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 SessionSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

getSessionClassPattern

public String getSessionClassPattern()
Returns the configuration parameter for specifying the concrete session bean class name pattern. By default the value is used for deciding the concrete session 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}Session" is used by default.
Returns:
The SessionClassPattern 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 SessionSubTask object
Parameters:
new_pattern - The new Pattern value

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -