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)

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

Field Summary
static StringDEFAULT_LOCAL_CLASS_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringlocalClassPattern
A configuration parameter for specifying the local interface name pattern.
Constructor Summary
LocalInterfaceSubTask()
Method Summary
protected voidengineStarted()
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the LocalInterfaceSubTask object
StringgetLocalClassPattern()
Returns the configuration parameter for specifying the local interface name pattern.
protected booleanmatchesGenerationRules(XClass clazz)
voidsetPattern(String new_pattern)
The pattern by which the interfaces are named.
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

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.

See Also: getLocalClassPattern

Constructor Detail

LocalInterfaceSubTask

public LocalInterfaceSubTask()

Method Detail

engineStarted

protected void engineStarted()

Throws: XDocletException

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the LocalInterfaceSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

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

See Also: localClassPattern

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

UNKNOWN: (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

UNKNOWN: No,defaultsto {0}Local

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException