xdoclet.modules.ejb.home

Class HomeInterfaceSubTask

public class HomeInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask

Generates remote home interfaces for EJBs.

Version: $Revision: 1.13 $

Author: Ara Abrahamian (ara_e@email.com)

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

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

Field Detail

DEFAULT_HOMEINTERFACE_CLASS_PATTERN

public static final String DEFAULT_HOMEINTERFACE_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

homeClassPattern

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

Constructor Detail

HomeInterfaceSubTask

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

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

getHomeClassPattern

public String getHomeClassPattern()
Returns the configuration parameter for specifying the home interface name pattern. By default the value is used for deciding the 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}Home" is used by default.

Returns: The HomeClassPattern value

See Also: homeClassPattern

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 home interfaces are named. The placeholder "{0}" designates the EJB name.

Parameters: new_pattern The new Pattern value

UNKNOWN: No,defaultsto {0}Home

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException