xdoclet.modules.ejb.entity
public class ValueObjectSubTask extends AbstractEjbCodeGeneratorSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
protected xjavadoc.XTag |
currentDataObjectTag
Form tag being processed right now
|
static java.lang.String |
DEFAULT_DATAOBJECT_CLASS_PATTERN |
protected static java.lang.String |
DEFAULT_TEMPLATE_FILE |
protected java.lang.String |
valueObjectClassPattern
A configuration parameter for specifying the data object class name pattern.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
ValueObjectSubTask()
Describe what the ValueObjectSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
protected void |
generateForClass(xjavadoc.XClass clazz)
Describe what the method does
|
static java.lang.String |
getCurrentValueObjectClass()
Gets the CurrentValueObjectClass attribute of the ValueObjectSubTask class
|
static java.lang.String |
getCurrentValueObjectExtends() |
static java.lang.String |
getCurrentValueObjectImplements() |
static java.lang.String |
getCurrentValueObjectMatch()
Gets the CurrentValueObjectMatch attribute of the ValueObjectSubTask class
|
static java.lang.String |
getCurrentValueObjectName()
Gets the CurrentValueObjectName attribute of the ValueObjectSubTask class
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the ValueObjectSubTask object
|
boolean |
getGeneratePKConstructor() |
java.lang.String |
getValueObjectClassPattern()
Returns the configuration parameter for specifying the data object class name pattern.
|
protected boolean |
matchesGenerationRules(xjavadoc.XClass clazz)
Describe what the method does
|
void |
setGeneratePKConstructor(java.lang.String generatePKConstructor)
Whether to generate a single-parameter constructor in the ValueObject, which only sets up the PK.
|
void |
setPattern(java.lang.String new_pattern)
The pattern by which the value object classes are named.
|
void |
validateOptions()
Called to validate configuration parameters.
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, 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_DATAOBJECT_CLASS_PATTERN
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String valueObjectClassPattern
getValueObjectClassPattern()
protected xjavadoc.XTag currentDataObjectTag
public ValueObjectSubTask()
public static java.lang.String getCurrentValueObjectClass()
public static java.lang.String getCurrentValueObjectImplements()
public static java.lang.String getCurrentValueObjectExtends()
public static java.lang.String getCurrentValueObjectName()
public static java.lang.String getCurrentValueObjectMatch()
public java.lang.String getValueObjectClassPattern()
valueObjectClassPattern
public boolean getGeneratePKConstructor()
public void setPattern(java.lang.String new_pattern)
new_pattern
- The new Pattern valuepublic void setGeneratePKConstructor(java.lang.String generatePKConstructor)
generatePKConstructor
- The new GeneratePKConstructor 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 generateForClass(xjavadoc.XClass clazz) throws XDocletException
generateForClass
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException