xdoclet

Class DocletSupport

public abstract class DocletSupport extends Object

Version: $Revision: 1.16 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 13, 2001

Field Summary
protected static XTagcurrentClassTag
protected static XTagcurrentFieldTag
protected static XTagcurrentMethodTag
The current Tag.
Constructor Summary
DocletSupport()
Method Summary
XClassgetCurrentClass()
Peeks and return the current class from top of currentClassStack stack.
static XTaggetCurrentClassTag()
Gets the CurrentClassTag attribute of the DocletSupport class
XConstructorgetCurrentConstructor()
Returns current constructor.
XFieldgetCurrentField()
Returns current field.
static XTaggetCurrentFieldTag()
Gets the CurrentFieldTag attribute of the DocletSupport field
XMethodgetCurrentMethod()
Returns current method.
static XTaggetCurrentMethodTag()
Gets the CurrentMethodTag attribute of the DocletSupport class
XPackagegetCurrentPackage()
Returns current package.
static XTaggetCurrentTag()
This method is for backward compatiblity only.
static booleanisDocletGenerated(XClass clazz)
Returns true if the clazz generated by xdoclet.
XClasspopCurrentClass()
Popes current class from top currentClassStack stack.
XClasspushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
voidsetCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
static voidsetCurrentClassTag(XTag currentTag)
Sets the CurrentClassTag attribute of the DocletSupport class
voidsetCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object
voidsetCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object
static voidsetCurrentFieldTag(XTag currentTag)
Sets the CurrentFieldTag attribute of the DocletSupport field
voidsetCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object
static voidsetCurrentMethodTag(XTag currentTag)
Sets the CurrentMethodTag attribute of the DocletSupport class
voidsetCurrentPackage(XPackage pakkage)
Returns current package.

Field Detail

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 Detail

DocletSupport

public DocletSupport()

Method Detail

getCurrentClass

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

Returns: The CurrentClass value

See Also: setCurrentClass

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

getCurrentField

public XField getCurrentField()
Returns current field.

Returns: The CurrentField value

See Also: setCurrentField

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

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

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 pushCurrentClass

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 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

UNKNOWN:

setCurrentClassTag

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

Parameters: currentTag The new CurrentClassTag value

UNKNOWN:

setCurrentConstructor

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

Parameters: constructor The new CurrentConstructor value

UNKNOWN:

setCurrentField

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

Parameters: field The new CurrentField value

UNKNOWN:

setCurrentFieldTag

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

Parameters: currentTag The new CurrentFieldTag value

UNKNOWN:

setCurrentMethod

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

Parameters: method The new CurrentMethod value

UNKNOWN:

setCurrentMethodTag

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

Parameters: currentTag The new CurrentMethodTag value

UNKNOWN:

setCurrentPackage

public void setCurrentPackage(XPackage pakkage)
Returns current package.

Parameters: pakkage The new CurrentPackage value

See Also: setCurrentPackage

UNKNOWN: