xdoclet.modules.ejb.intf

Class RemoteInterfaceSubTask

public class RemoteInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask

Generates remote interfaces for EJBs.

Version: $Revision: 1.12 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 15, 2001 display-name = "Remote Interface" name = "remoteinterface" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "remote-custom.xdt" relates-to = "{0}.java" description = "A text file containing custom * template and/or java code to include in the remote interface."

Field Summary
static String	DEFAULT_REMOTE_CLASS_PATTERN
protected static String	DEFAULT_TEMPLATE_FILE
protected String	remoteClassPattern A configuration parameter for specifying the remote interface name pattern.

Constructor Summary
	RemoteInterfaceSubTask() Describe what the RemoteInterfaceSubTask constructor does

Method Summary
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.

Field Detail

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.

Constructor Detail

RemoteInterfaceSubTask

public RemoteInterfaceSubTask()

Describe what the RemoteInterfaceSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()

Describe what the method does

Throws: XDocletException

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)

Gets the GeneratedFileName attribute of the RemoteInterfaceSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: 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.

Returns: The RemoteClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Describe what the method does

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

setPattern

public void setPattern(String newPattern)

The pattern by which the interfaces are named. The placeholder "{0}" designates the EJB name.

Parameters: newPattern The new Pattern value

UNKNOWN: No,defaultsto {0}

validateOptions

public void validateOptions()

Called to validate configuration parameters.

Throws: XDocletException