xdoclet
Class DocletSupport

java.lang.Object
  |
  +--xdoclet.DocletSupport

Direct Known Subclasses:

SubTask

public abstract class DocletSupport

extends java.lang.Object

Version:

$Revision: 1.6 $

Author:

Ara Abrahamian (ara_e@email.com)

Field Summary

protected static com.sun.javadoc.Tag

currentTag The current Tag.

Constructor Summary

DocletSupport()

Method Summary

com.sun.javadoc.ClassDoc	getCurrentClass() Peeks and return the current class from top of currentClassStack stack.
com.sun.javadoc.ConstructorDoc	getCurrentConstructor() Returns current constructor.
com.sun.javadoc.FieldDoc	getCurrentField() Returns current field.
com.sun.javadoc.MethodDoc	getCurrentMethod() Returns current method.
com.sun.javadoc.PackageDoc	getCurrentPackage() Returns current package.
static com.sun.javadoc.Tag	getCurrentTag()
static boolean	isDocletGenerated(com.sun.javadoc.ClassDoc clazz) Returns true if the clazz generated by xdoclet.
com.sun.javadoc.ClassDoc	popCurrentClass() Popes current class from top currentClassStack stack.
com.sun.javadoc.ClassDoc	pushCurrentClass(com.sun.javadoc.ClassDoc clazz) Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
void	setCurrentClass(com.sun.javadoc.ClassDoc clazz) Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
void	setCurrentConstructor(com.sun.javadoc.ConstructorDoc constructor)
void	setCurrentField(com.sun.javadoc.FieldDoc field)
void	setCurrentMethod(com.sun.javadoc.MethodDoc method)
void	setCurrentPackage(com.sun.javadoc.PackageDoc pakkage) Returns current package.
static void	setCurrentTag(com.sun.javadoc.Tag currentTag)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentTag

protected static com.sun.javadoc.Tag currentTag

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

getCurrentTag

public static com.sun.javadoc.Tag getCurrentTag()

isDocletGenerated

public static boolean isDocletGenerated(com.sun.javadoc.ClassDoc 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

setCurrentTag

public static void setCurrentTag(com.sun.javadoc.Tag currentTag)

getCurrentClass

public com.sun.javadoc.ClassDoc getCurrentClass()

Peeks and return the current class from top of currentClassStack stack.

Returns:

The CurrentClass value

See Also:

setCurrentClass(com.sun.javadoc.ClassDoc)

getCurrentPackage

public com.sun.javadoc.PackageDoc getCurrentPackage()

Returns current package.

Returns:

The CurrentPackage value

See Also:

setCurrentPackage(com.sun.javadoc.PackageDoc)

getCurrentMethod

public com.sun.javadoc.MethodDoc getCurrentMethod()

Returns current method.

Returns:

The CurrentMethod value

See Also:

setCurrentMethod(com.sun.javadoc.MethodDoc)

getCurrentConstructor

public com.sun.javadoc.ConstructorDoc getCurrentConstructor()

Returns current constructor.

Returns:

The CurrentConstructor value

See Also:

setCurrentConstructor(com.sun.javadoc.ConstructorDoc)

getCurrentField

public com.sun.javadoc.FieldDoc getCurrentField()

Returns current field.

Returns:

The CurrentField value

See Also:

setCurrentField(com.sun.javadoc.FieldDoc)

setCurrentPackage

public void setCurrentPackage(com.sun.javadoc.PackageDoc pakkage)

Returns current package.

Parameters:

pakkage - The new CurrentPackage value

See Also:

setCurrentPackage(com.sun.javadoc.PackageDoc)

setCurrentMethod

public void setCurrentMethod(com.sun.javadoc.MethodDoc method)

setCurrentConstructor

public void setCurrentConstructor(com.sun.javadoc.ConstructorDoc constructor)

setCurrentField

public void setCurrentField(com.sun.javadoc.FieldDoc field)

setCurrentClass

public void setCurrentClass(com.sun.javadoc.ClassDoc 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()

pushCurrentClass

public com.sun.javadoc.ClassDoc pushCurrentClass(com.sun.javadoc.ClassDoc 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(com.sun.javadoc.ClassDoc), popCurrentClass()

popCurrentClass

public com.sun.javadoc.ClassDoc 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(com.sun.javadoc.ClassDoc), pushCurrentClass(com.sun.javadoc.ClassDoc)