|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.entity.EntityPkSubTask
public class EntityPkSubTask
Generates primary key classes for entity EJBs.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask |
---|
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType |
Field Summary | |
---|---|
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. |
Fields inherited from class xdoclet.DocletSupport |
---|
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
---|---|
EntityPkSubTask()
Describe what the EntityPkSubTask constructor does |
Method Summary | |
---|---|
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. |
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 java.lang.String DEFAULT_ENTITY_PK_CLASS_PATTERN
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String entityPkClassPattern
getEntityPkClassPattern()
Constructor Detail |
---|
public EntityPkSubTask()
Method Detail |
---|
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 does
XDocletException
protected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
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 |