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