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)

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

Field Summary
static StringDEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringlocalHomeClassPattern
A configuration parameter for specifying the local home interface name pattern.
Constructor Summary
LocalHomeInterfaceSubTask()
Describe what the LocalHomeInterfaceSubTask constructor does
Method Summary
protected voidengineStarted()
Describe what the method does
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the LocalHomeInterfaceSubTask object
StringgetLocalHomeClassPattern()
Returns the configuration parameter for specifying the local home interface name pattern.
protected booleanmatchesGenerationRules(XClass clazz)
Describe what the method does
voidsetPattern(String new_pattern)
The pattern by which the local home interfaces are named.
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

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.

See Also: getLocalHomeClassPattern

Constructor Detail

LocalHomeInterfaceSubTask

public LocalHomeInterfaceSubTask()
Describe what the LocalHomeInterfaceSubTask 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 LocalHomeInterfaceSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

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

See Also: localHomeClassPattern

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

UNKNOWN: No,defaultsto {0}LocalHome

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException