xdoclet.modules.ejb.intf

Class LocalInterfaceSubTask


public class LocalInterfaceSubTask
extends AbstractEjbCodeGeneratorSubTask

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

Field Summary

static String
DEFAULT_LOCAL_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
localClassPattern
A configuration parameter for specifying the local interface name pattern.

Constructor Summary

LocalInterfaceSubTask()

Method Summary

protected void
engineStarted()
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the LocalInterfaceSubTask object
String
getLocalClassPattern()
Returns the configuration parameter for specifying the local interface name pattern.
protected boolean
matchesGenerationRules(XClass clazz)
void
setPattern(String new_pattern)
The pattern by which the interfaces are named.
void
validateOptions()
Called to validate configuration parameters.

Field Details

DEFAULT_LOCAL_CLASS_PATTERN

public static final String DEFAULT_LOCAL_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

localClassPattern

protected String localClassPattern
A configuration parameter for specifying the local interface name pattern. By default the value is used for deciding the local 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

LocalInterfaceSubTask

public LocalInterfaceSubTask()

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException -

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the LocalInterfaceSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

getLocalClassPattern

public String getLocalClassPattern()
Returns the configuration parameter for specifying the local interface name pattern. By default the value is used for deciding the local 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}Local" is used by default.
Returns:
The LocalClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException -
To do:
(Aslak) This needs refactoring. Nearly all matchesGenerationRules implementations are the same!

setPattern

public void setPattern(String new_pattern)
The pattern by which the interfaces are named. The placeholder "{0}" designates the EJB name.
Parameters:
new_pattern -
ant.not-required
No,defaultsto {0}Local

validateOptions

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