xdoclet.modules.ejb.home

Class LocalHomeInterfaceSubTask


public class LocalHomeInterfaceSubTask
extends AbstractEjbCodeGeneratorSubTask

Generates local home interfaces for EJBs.
Version:
$Revision: 1.13 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "Local Home Interface" name = "localhomeinterface" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Field Summary

static String
DEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
localHomeClassPattern
A configuration parameter for specifying the local home interface name pattern.

Constructor Summary

LocalHomeInterfaceSubTask()
Describe what the LocalHomeInterfaceSubTask constructor does

Method Summary

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.

Field Details

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.

Constructor Details

LocalHomeInterfaceSubTask

public LocalHomeInterfaceSubTask()
Describe what the LocalHomeInterfaceSubTask 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 LocalHomeInterfaceSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
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.
Returns:
The LocalHomeClassPattern 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)
The pattern by which the local home interfaces are named. The placeholder "{0}" designates the EJB name.
Parameters:
new_pattern - The new Pattern value
ant.not-required
No,defaultsto {0}LocalHome

validateOptions

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