xdoclet.modules.ejb.session

Class SessionSubTask

public class SessionSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.8 $

Author: Ara Abrahamian (ara_e@email.com)

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

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

Field Detail

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.

See Also: getSessionClassPattern

Constructor Detail

SessionSubTask

public SessionSubTask()
Describe what the SessionSubTask 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 SessionSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: 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

See Also: sessionClassPattern

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 SessionSubTask object

Parameters: new_pattern The new Pattern value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException