xdoclet.modules.ejb.home
public class HomeInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
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.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
HomeInterfaceSubTask()
Describe what the HomeInterfaceSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
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.
|
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
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
public static final java.lang.String DEFAULT_HOMEINTERFACE_CLASS_PATTERN
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String homeClassPattern
getHomeClassPattern()
public HomeInterfaceSubTask()
public java.lang.String getHomeClassPattern()
homeClassPattern
public void setPattern(java.lang.String new_pattern)
new_pattern
- The new Pattern valuepublic void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz) throws XDocletException
getGeneratedFileName
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
protected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException