|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.modules.jdo.VendorExtensionsSubTask
public abstract class VendorExtensionsSubTask
Field Summary | |
---|---|
static java.lang.String |
COLUMN_NAME_ATTR
|
static java.lang.String |
RELATED_FIELD_ATTR
|
static java.lang.String |
SQL_FIELD_TAG
|
static java.lang.String |
SQL_RELATION_TAG
|
static java.lang.String |
SQL_TABLE_TAG
|
static java.lang.String |
STYLE_ATTR
|
static java.lang.String |
STYLE_FOREIGN_KEY_VALUE
|
static java.lang.String |
STYLE_RELATION_TABLE_VALUE
|
static java.lang.String |
TABLE_NAME_ATTR
|
Fields inherited from class xdoclet.DocletSupport |
---|
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
---|---|
VendorExtensionsSubTask()
|
Method Summary | |
---|---|
void |
execute()
Called to start execution of the sub-task. |
protected abstract java.util.Collection |
getArrayExtensions()
|
protected abstract java.util.Collection |
getClassExtensions()
|
protected abstract java.util.Collection |
getCollectionExtensions()
|
xjavadoc.XClass |
getCurrentClass()
Peeks and return the current class from top of currentClassStack stack. |
xjavadoc.XConstructor |
getCurrentConstructor()
Returns current constructor. |
xjavadoc.XField |
getCurrentField()
Returns current field. |
xjavadoc.XMethod |
getCurrentMethod()
Returns current method. |
xjavadoc.XPackage |
getCurrentPackage()
Returns current package. |
protected java.util.Collection |
getExtensions(java.lang.String level)
|
protected abstract java.util.Collection |
getFieldExtensions()
|
protected abstract java.util.Collection |
getMapExtensions()
|
protected JdoXmlMetadataSubTask |
getMetadataSubTask()
|
abstract java.lang.String |
getVendorDescription()
|
abstract java.lang.String |
getVendorName()
|
xjavadoc.XClass |
popCurrentClass()
Popes current class from top currentClassStack stack. |
xjavadoc.XClass |
pushCurrentClass(xjavadoc.XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class. |
void |
setCurrentClass(xjavadoc.XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it. |
void |
setCurrentConstructor(xjavadoc.XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object |
void |
setCurrentField(xjavadoc.XField field)
Sets the CurrentField attribute of the DocletSupport object |
void |
setCurrentMethod(xjavadoc.XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object |
void |
setCurrentPackage(xjavadoc.XPackage pakkage)
Returns current package. |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, copyAttributesFrom, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions |
Methods inherited from class xdoclet.DocletSupport |
---|
getCurrentClassTag, getCurrentFieldTag, getCurrentMethodTag, getCurrentTag, isDocletGenerated, setCurrentClassTag, setCurrentFieldTag, setCurrentMethodTag |
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 SQL_TABLE_TAG
public static final java.lang.String SQL_FIELD_TAG
public static final java.lang.String TABLE_NAME_ATTR
public static final java.lang.String COLUMN_NAME_ATTR
public static final java.lang.String RELATED_FIELD_ATTR
public static final java.lang.String SQL_RELATION_TAG
public static final java.lang.String STYLE_ATTR
public static final java.lang.String STYLE_FOREIGN_KEY_VALUE
public static final java.lang.String STYLE_RELATION_TABLE_VALUE
Constructor Detail |
---|
public VendorExtensionsSubTask()
Method Detail |
---|
public abstract java.lang.String getVendorName()
public abstract java.lang.String getVendorDescription()
public xjavadoc.XClass getCurrentClass()
getCurrentClass
in class DocletSupport
setCurrentClass(xjavadoc.XClass)
public xjavadoc.XPackage getCurrentPackage()
getCurrentPackage
in class DocletSupport
setCurrentPackage(xjavadoc.XPackage)
public xjavadoc.XMethod getCurrentMethod()
getCurrentMethod
in class DocletSupport
setCurrentMethod(xjavadoc.XMethod)
public xjavadoc.XConstructor getCurrentConstructor()
getCurrentConstructor
in class DocletSupport
setCurrentConstructor(xjavadoc.XConstructor)
public xjavadoc.XField getCurrentField()
getCurrentField
in class DocletSupport
setCurrentField(xjavadoc.XField)
public void setCurrentPackage(xjavadoc.XPackage pakkage)
setCurrentPackage
in class DocletSupport
pakkage
- The new CurrentPackage valuesetCurrentPackage(xjavadoc.XPackage)
public void setCurrentMethod(xjavadoc.XMethod method)
setCurrentMethod
in class DocletSupport
method
- The new CurrentMethod valuepublic void setCurrentConstructor(xjavadoc.XConstructor constructor)
setCurrentConstructor
in class DocletSupport
constructor
- The new CurrentConstructor valuepublic void setCurrentField(xjavadoc.XField field)
setCurrentField
in class DocletSupport
field
- The new CurrentField valuepublic void setCurrentClass(xjavadoc.XClass clazz)
setCurrentClass
in class DocletSupport
clazz
- The new CurrentClass valuegetCurrentClass()
public xjavadoc.XClass pushCurrentClass(xjavadoc.XClass clazz)
pushCurrentClass
in class DocletSupport
clazz
- Description of Parameter
getCurrentClass()
,
setCurrentClass(xjavadoc.XClass)
,
popCurrentClass()
public xjavadoc.XClass popCurrentClass()
popCurrentClass
in class DocletSupport
getCurrentClass()
,
setCurrentClass(xjavadoc.XClass)
,
pushCurrentClass(xjavadoc.XClass)
public void execute() throws XDocletException
SubTask
execute
in class SubTask
XDocletException
SubTask.execute()
protected JdoXmlMetadataSubTask getMetadataSubTask()
protected java.util.Collection getExtensions(java.lang.String level) throws XDocletException
XDocletException
protected abstract java.util.Collection getClassExtensions() throws XDocletException
XDocletException
protected abstract java.util.Collection getFieldExtensions() throws XDocletException
XDocletException
protected abstract java.util.Collection getCollectionExtensions() throws XDocletException
XDocletException
protected abstract java.util.Collection getArrayExtensions() throws XDocletException
XDocletException
protected abstract java.util.Collection getMapExtensions() throws XDocletException
XDocletException
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |