xdoclet.modules.ejb.entity
public class EntityPkSubTask extends AbstractEjbCodeGeneratorSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ENTITY_PK_CLASS_PATTERN |
protected static java.lang.String |
DEFAULT_TEMPLATE_FILE |
protected java.lang.String |
entityPkClassPattern
A configuration parameter for specifying the entity bean primary class name pattern.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
EntityPkSubTask()
Describe what the EntityPkSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
java.lang.String |
getEntityPkClassPattern()
Returns the configuration parameter for specifying the entity bean primary class name pattern.
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the EntityPkSubTask object
|
protected boolean |
matchesGenerationRules(xjavadoc.XClass clazz)
Describe what the method does
|
void |
setPattern(java.lang.String new_pattern)
The pattern by which the primary key classes 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_ENTITY_PK_CLASS_PATTERN
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String entityPkClassPattern
getEntityPkClassPattern()
public EntityPkSubTask()
public java.lang.String getEntityPkClassPattern()
entityPkClassPattern
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