xdoclet.modules.ejb.home
Class LocalHomeInterfaceSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.home.LocalHomeInterfaceSubTask
public class LocalHomeInterfaceSubTask
extends AbstractEjbCodeGeneratorSubTask
Generates local home interfaces for EJBs.
- Ara Abrahamian (ara_e@email.com)
- display-name = "Local Home Interface"
name = "localhomeinterface"
parent = "xdoclet.modules.ejb.EjbDocletTask"
protected void | engineStarted() - Describe what the method does
|
protected String | getGeneratedFileName(XClass clazz) - Gets the GeneratedFileName attribute of the LocalHomeInterfaceSubTask object
|
String | getLocalHomeClassPattern() - Returns the configuration parameter for specifying the local home interface name pattern.
|
protected boolean | matchesGenerationRules(XClass clazz) - Describe what the method does
|
void | setPattern(String new_pattern) - The pattern by which the local home interfaces are named.
|
void | validateOptions() - Called to validate configuration parameters.
|
DEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN
public static final String DEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN
DEFAULT_TEMPLATE_FILE
protected static final String DEFAULT_TEMPLATE_FILE
localHomeClassPattern
protected String localHomeClassPattern
A configuration parameter for specifying the local home interface name pattern. By default the value is used for
deciding the local home interface name. The placeholder "{0}" in the value means the current class's symbolic
name which for an EJBean is the EJB name.
LocalHomeInterfaceSubTask
public LocalHomeInterfaceSubTask()
Describe what the LocalHomeInterfaceSubTask 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 LocalHomeInterfaceSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
-
getLocalHomeClassPattern
public String getLocalHomeClassPattern()
Returns the configuration parameter for specifying the local home interface name pattern. By default the value is
used for deciding the local 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}LocalHome" is
used by default.
- The LocalHomeClassPattern 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 local home interfaces are named. The placeholder "{0}" designates the EJB name.
new_pattern
- The new Pattern value
- No,defaultsto
{0}LocalHome
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
-