xdoclet.modules.ejb.entity
public class EntityCmpSubTask extends AbstractEjbCodeGeneratorSubTask
Modifier and Type | Class and Description |
---|---|
static class |
EntityCmpSubTask.CmpSpecVersion |
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ENTITYCMP_CLASS_PATTERN |
protected static java.lang.String |
DEFAULT_TEMPLATE_FILE |
protected java.lang.String |
entityCmpClassPattern
A configuration parameter for specifying the concrete CMP entity bean class name pattern.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
EntityCmpSubTask()
Describe what the EntityCmpSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
java.lang.String |
getCmpSpec()
Gets the CmpSpec attribute of the EntityCmpSubTask object
|
java.lang.String |
getEntityCmpClassPattern()
Returns the configuration parameter for specifying the concrete CMP entity bean class name pattern.
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
|
protected boolean |
matchesGenerationRules(xjavadoc.XClass clazz)
Returns true if output not already generated for clazz, and is of the specified type and has the specified class
tag; false otherwise.
|
void |
setCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
Sets the CmpSpec attribute of the EntityCmpSubTask object
|
void |
setPattern(java.lang.String new_pattern)
Sets the Pattern attribute of the EntityCmpSubTask object
|
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_ENTITYCMP_CLASS_PATTERN
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String entityCmpClassPattern
getEntityCmpClassPattern()
public EntityCmpSubTask()
public java.lang.String getCmpSpec()
public java.lang.String getEntityCmpClassPattern()
entityCmpClassPattern
public void setCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
cmpspec
- The new CmpSpec valuepublic 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
TemplateSubTask
matchesGenerationRules
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException