|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object xdoclet.DocletSupport xdoclet.SubTask xdoclet.TemplateSubTask xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask xdoclet.modules.ejb.entity.ValueObjectSubTask
Creates "value objects" for Entity EJBs. This task replaces Data Object .
Nested Class Summary |
Nested classes inherited from class xdoclet.TemplateSubTask |
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType |
Field Summary | |
protected xjavadoc.XTag |
currentDataObjectTag
Form tag being processed right now |
static String |
DEFAULT_DATAOBJECT_CLASS_PATTERN
|
protected static String |
DEFAULT_TEMPLATE_FILE
|
protected String |
valueObjectClassPattern
A configuration parameter for specifying the data object class name pattern. |
Fields inherited from class xdoclet.DocletSupport |
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
ValueObjectSubTask()
Describe what the ValueObjectSubTask constructor does |
Method Summary | |
protected void |
engineStarted()
Describe what the method does |
protected void |
generateForClass(xjavadoc.XClass clazz)
Describe what the method does |
static String |
getCurrentValueObjectClass()
Gets the CurrentValueObjectClass attribute of the ValueObjectSubTask class |
static String |
getCurrentValueObjectExtends()
|
static String |
getCurrentValueObjectImplements()
|
static String |
getCurrentValueObjectMatch()
Gets the CurrentValueObjectMatch attribute of the ValueObjectSubTask class |
static String |
getCurrentValueObjectName()
Gets the CurrentValueObjectName attribute of the ValueObjectSubTask class |
protected String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the ValueObjectSubTask object |
boolean |
getGeneratePKConstructor()
|
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(String generatePKConstructor)
Whether to generate a single-parameter constructor in the ValueObject, which only sets up the PK. |
void |
setPattern(String new_pattern)
The pattern by which the value object classes are named. |
void |
validateOptions()
Called to validate configuration parameters. |
Methods inherited from class xdoclet.SubTask |
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String DEFAULT_DATAOBJECT_CLASS_PATTERN
protected static final String DEFAULT_TEMPLATE_FILE
protected String valueObjectClassPattern
getValueObjectClassPattern()
protected xjavadoc.XTag currentDataObjectTag
Constructor Detail |
public ValueObjectSubTask()
Method Detail |
public static String getCurrentValueObjectClass()
public static String getCurrentValueObjectImplements()
public static String getCurrentValueObjectExtends()
public static String getCurrentValueObjectName()
public static String getCurrentValueObjectMatch()
public String getValueObjectClassPattern()
valueObjectClassPattern
public boolean getGeneratePKConstructor()
public void setPattern(String new_pattern)
new_pattern
- The new Pattern valuepublic void setGeneratePKConstructor(String generatePKConstructor)
generatePKConstructor
- The new GeneratePKConstructor valuepublic void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
protected String getGeneratedFileName(xjavadoc.XClass clazz) throws XDocletException
getGeneratedFileName
in class TemplateSubTask
clazz
- Describe what the parameter does
XDocletException
protected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
in class TemplateSubTask
clazz
- Describe what the parameter does
XDocletException
protected void generateForClass(xjavadoc.XClass clazz) throws XDocletException
generateForClass
in class TemplateSubTask
clazz
- Describe what the parameter does
XDocletException
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
|
http://xdoclet.sourceforge.net/ | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |