xdoclet

Class DocletSupport

Known Direct Subclasses:
SubTask

public abstract class DocletSupport
extends java.lang.Object

Version:
$Revision: 1.16 $

Author:
Ara Abrahamian (ara_e@email.com)

created
Oct 13, 2001

Field Summary

protected static XTag
currentClassTag
protected static XTag
currentFieldTag
protected static XTag
currentMethodTag
The current Tag.

Constructor Summary

DocletSupport()

Method Summary

XClass
getCurrentClass()
Peeks and return the current class from top of currentClassStack stack.
static XTag
getCurrentClassTag()
Gets the CurrentClassTag attribute of the DocletSupport class
XConstructor
getCurrentConstructor()
Returns current constructor.
XField
getCurrentField()
Returns current field.
static XTag
getCurrentFieldTag()
Gets the CurrentFieldTag attribute of the DocletSupport field
XMethod
getCurrentMethod()
Returns current method.
static XTag
getCurrentMethodTag()
Gets the CurrentMethodTag attribute of the DocletSupport class
XPackage
getCurrentPackage()
Returns current package.
static XTag
getCurrentTag()
This method is for backward compatiblity only.
static boolean
isDocletGenerated(XClass clazz)
Returns true if the clazz generated by xdoclet.
XClass
popCurrentClass()
Popes current class from top currentClassStack stack.
XClass
pushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
void
setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
static void
setCurrentClassTag(XTag currentTag)
Sets the CurrentClassTag attribute of the DocletSupport class
void
setCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object
void
setCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object
static void
setCurrentFieldTag(XTag currentTag)
Sets the CurrentFieldTag attribute of the DocletSupport field
void
setCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object
static void
setCurrentMethodTag(XTag currentTag)
Sets the CurrentMethodTag attribute of the DocletSupport class
void
setCurrentPackage(XPackage pakkage)
Returns current package.

Field Details

currentClassTag

protected static XTag currentClassTag


currentFieldTag

protected static XTag currentFieldTag


currentMethodTag

protected static XTag currentMethodTag
The current Tag. Various template tag implementations set this value, including looping tags such as forAllClassTags. There's no distinction between class/method/field/constructor/whatever tags, and currentTag can point to any one them.

Constructor Details

DocletSupport

public DocletSupport()

Method Details

getCurrentClass

public XClass getCurrentClass()
Peeks and return the current class from top of currentClassStack stack.

Returns:
The CurrentClass value

See Also:
setCurrentClass(xjavadoc.XClass)


getCurrentClassTag

public static XTag getCurrentClassTag()
Gets the CurrentClassTag attribute of the DocletSupport class

Returns:
The CurrentClassTag value


getCurrentConstructor

public XConstructor getCurrentConstructor()
Returns current constructor.

Returns:
The CurrentConstructor value

See Also:
setCurrentConstructor(xjavadoc.XConstructor)


getCurrentField

public XField getCurrentField()
Returns current field.

Returns:
The CurrentField value

See Also:
setCurrentField(xjavadoc.XField)


getCurrentFieldTag

public static XTag getCurrentFieldTag()
Gets the CurrentFieldTag attribute of the DocletSupport field

Returns:
The CurrentFieldTag value


getCurrentMethod

public XMethod getCurrentMethod()
Returns current method.

Returns:
The CurrentMethod value

See Also:
setCurrentMethod(xjavadoc.XMethod)


getCurrentMethodTag

public static XTag getCurrentMethodTag()
Gets the CurrentMethodTag attribute of the DocletSupport class

Returns:
The CurrentMethodTag value


getCurrentPackage

public XPackage getCurrentPackage()
Returns current package.

Returns:
The CurrentPackage value

See Also:
setCurrentPackage(xjavadoc.XPackage)


getCurrentTag

public static XTag getCurrentTag()
This method is for backward compatiblity only. Method or Class Tag getter should be used instead.

Returns:
The CurrentTag value


isDocletGenerated

public static boolean isDocletGenerated(XClass clazz)
Returns true if the clazz generated by xdoclet. An xdoclet generated class has a class-level xdoclet-generated tag.

Parameters:
clazz - Description of Parameter

Returns:
The DocletGenerated value


popCurrentClass

public XClass popCurrentClass()
Popes current class from top currentClassStack stack. The poped class is no longer the current class.

Returns:
Description of the Returned Value

See Also:
getCurrentClass(), setCurrentClass(xjavadoc.XClass), pushCurrentClass(xjavadoc.XClass)


pushCurrentClass

public XClass pushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.

Parameters:
clazz - Description of Parameter

Returns:
Description of the Returned Value

See Also:
getCurrentClass(), setCurrentClass(xjavadoc.XClass), popCurrentClass()


setCurrentClass

public void setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.

Parameters:
clazz - The new CurrentClass value

See Also:
getCurrentClass()

ant.element


setCurrentClassTag

public static void setCurrentClassTag(XTag currentTag)
Sets the CurrentClassTag attribute of the DocletSupport class

Parameters:
currentTag - The new CurrentClassTag value

ant.element


setCurrentConstructor

public void setCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object

Parameters:
constructor - The new CurrentConstructor value

ant.element


setCurrentField

public void setCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object

Parameters:
field - The new CurrentField value

ant.element


setCurrentFieldTag

public static void setCurrentFieldTag(XTag currentTag)
Sets the CurrentFieldTag attribute of the DocletSupport field

Parameters:
currentTag - The new CurrentFieldTag value

ant.element


setCurrentMethod

public void setCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object

Parameters:
method - The new CurrentMethod value

ant.element


setCurrentMethodTag

public static void setCurrentMethodTag(XTag currentTag)
Sets the CurrentMethodTag attribute of the DocletSupport class

Parameters:
currentTag - The new CurrentMethodTag value

ant.element


setCurrentPackage

public void setCurrentPackage(XPackage pakkage)
Returns current package.

Parameters:
pakkage - The new CurrentPackage value

See Also:
setCurrentPackage(xjavadoc.XPackage)

ant.element