xdoclet.modules.ejb.home
Class HomeInterfaceSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.home.HomeInterfaceSubTask
public class HomeInterfaceSubTask
extends AbstractEjbCodeGeneratorSubTask
Generates remote home interfaces for EJBs.
- Ara Abrahamian (ara_e@email.com)
- display-name = "Home Interface"
name = "homeinterface"
parent = "xdoclet.modules.ejb.EjbDocletTask"
protected void | engineStarted() - Describe what the method does
|
protected String | getGeneratedFileName(XClass clazz) - Gets the GeneratedFileName attribute of the HomeInterfaceSubTask object
|
String | getHomeClassPattern() - Returns the configuration parameter for specifying the home interface name pattern.
|
protected boolean | matchesGenerationRules(XClass clazz) - Describe what the method does
|
void | setPattern(String new_pattern) - The pattern by which the home interfaces are named.
|
void | validateOptions() - Called to validate configuration parameters.
|
DEFAULT_HOMEINTERFACE_CLASS_PATTERN
public static final String DEFAULT_HOMEINTERFACE_CLASS_PATTERN
DEFAULT_TEMPLATE_FILE
protected static final String DEFAULT_TEMPLATE_FILE
homeClassPattern
protected String homeClassPattern
A configuration parameter for specifying the home interface name pattern. By default the value is used for
deciding the home interface name. The placeholder "{0}" in the value means the current class's symbolic name
which for an EJBean is the EJB name.
HomeInterfaceSubTask
public HomeInterfaceSubTask()
Describe what the HomeInterfaceSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
xdoclet.XDocletException
-
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the HomeInterfaceSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
-
getHomeClassPattern
public String getHomeClassPattern()
Returns the configuration parameter for specifying the home interface name pattern. By default the value is used
for deciding the home interface name. The placeholder "{0}" in the value means the current class's symbolic name
which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}Home" is used by default.
- The HomeClassPattern value
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
Describe what the method does
clazz
- Describe what the parameter does
- Describe the return value
xdoclet.XDocletException
-
setPattern
public void setPattern(String new_pattern)
The pattern by which the home interfaces are named. The placeholder "{0}" designates the EJB name.
new_pattern
- The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
-