xdoclet.modules.ejb.home
Class HomeInterfaceSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask
                  extended by xdoclet.modules.ejb.home.HomeInterfaceSubTask
All Implemented Interfaces:
java.io.Serializable

public class HomeInterfaceSubTask
extends AbstractEjbCodeGeneratorSubTask

Generates remote home interfaces for EJBs.

Version:
$Revision: 1.13 $
Author:
Ara Abrahamian (ara_e@email.com)
See Also:
Serialized Form
ant.element
display-name = "Home Interface" name = "homeinterface" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Nested Class Summary
 
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
 
Field Summary
static java.lang.String DEFAULT_HOMEINTERFACE_CLASS_PATTERN
           
protected static java.lang.String DEFAULT_TEMPLATE_FILE
           
protected  java.lang.String homeClassPattern
          A configuration parameter for specifying the home interface name pattern.
 
Fields inherited from class xdoclet.DocletSupport
currentClassTag, currentFieldTag, currentMethodTag
 
Constructor Summary
HomeInterfaceSubTask()
          Describe what the HomeInterfaceSubTask constructor does
 
Method Summary
protected  void engineStarted()
          Describe what the method does
protected  java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
          Gets the GeneratedFileName attribute of the HomeInterfaceSubTask object
 java.lang.String getHomeClassPattern()
          Returns the configuration parameter for specifying the home interface name pattern.
protected  boolean matchesGenerationRules(xjavadoc.XClass clazz)
          Describe what the method does
 void setPattern(java.lang.String new_pattern)
          The pattern by which the home interfaces are named.
 void validateOptions()
          Called to validate configuration parameters.
 
Methods inherited from class xdoclet.TemplateSubTask
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
Methods inherited from class xdoclet.DocletSupport
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_HOMEINTERFACE_CLASS_PATTERN

public static final java.lang.String DEFAULT_HOMEINTERFACE_CLASS_PATTERN
See Also:
Constant Field Values

DEFAULT_TEMPLATE_FILE

protected static final java.lang.String DEFAULT_TEMPLATE_FILE
See Also:
Constant Field Values

homeClassPattern

protected java.lang.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

getHomeClassPattern

public java.lang.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

setPattern

public void setPattern(java.lang.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
ant.not-required
No,defaultsto {0}Home

validateOptions

public void validateOptions()
                     throws XDocletException
Called to validate configuration parameters.

Overrides:
validateOptions in class TemplateSubTask
Throws:
XDocletException

getGeneratedFileName

protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
                                         throws XDocletException
Gets the GeneratedFileName attribute of the HomeInterfaceSubTask object

Overrides:
getGeneratedFileName in class TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(xjavadoc.XClass clazz)
                                  throws XDocletException
Describe what the method does

Overrides:
matchesGenerationRules in class TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
XDocletException

engineStarted

protected void engineStarted()
                      throws XDocletException
Describe what the method does

Overrides:
engineStarted in class TemplateSubTask
Throws:
XDocletException

http://xdoclet.sourceforge.net/