com.basecmp.core.util
Class AbstractTaglet

java.lang.Object
  com.basecmp.core.util.AbstractTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public abstract class AbstractTaglet

extends java.lang.Object

implements com.sun.tools.doclets.Taglet

Basis-Taglet nach Sun-Taglet-API.

Created on 21.01.2005

Author:

Wolfgang Schröder

Field Summary

protected int	format Steuert das Output-Format.
static int	FORMAT_AS_LIST Konstante mit die Instanzvariable format in Ableitugnen dieser Klassen gesetzt werden soll.
static int	FORMAT_AS_TABLE Konstante mit die Instanzvariable format in Ableitugnen dieser Klassen gesetzt werden soll.
protected java.lang.String	tagletHeader Enthält den Header-Output für das Custom-Taglet und muss im Konstruktor des abgeleiteten Taglet gesetzt werden.
protected java.lang.String	tagletName Enthält den Namen des Custom-Taglets und muss im Konstruktor des abgeleiteten Taglet gesetzt werden.

Constructor Summary

AbstractTaglet()

Method Summary

static java.lang.String	getListFormat(com.sun.javadoc.Tag[] tags, java.lang.String tagletHeader) Erzeugt für ein JavaDoc-Custom-Tag, welches von dieser Klasse abgeleitet ist, eine Parameterliste mit Beschreibungen: Syntax: @your-tagname a-parameter-name: description
java.lang.String	getName() Liefert den Taglet-Namen aus dem Feld tagletName.
static java.lang.String	getTableFormat(com.sun.javadoc.Tag[] tags, java.lang.String tagletHeader) Erzeugt für ein JavaDoc-Custom-Tag, welches von dieser Klasse abgeleitet ist eine Tabelle mit den Spalten 'Parameter' und 'Description'.
boolean	inConstructor() Liefert false.
boolean	inField() Liefert false.
boolean	inMethod() Liefert false.
boolean	inOverview() Liefert false.
boolean	inPackage() Liefert false.
boolean	inType() Liefert true.
boolean	isInlineTag() Liefert false.
java.lang.String	toString(com.sun.javadoc.Tag tag) Ruft toString(Tag [] tags) mit tag als 1-elementiges Array auf.
java.lang.String	toString(com.sun.javadoc.Tag[] tags) Ruft in Abhängigkeit von Instanzvariable format eine der statischen Format-Methoden auf.

Methods inherited from class java.lang.Object

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

Field Detail

format

protected int format

Steuert das Output-Format. Default ist FORMAT_AS_LIST.

FORMAT_AS_LIST

public static final int FORMAT_AS_LIST

Konstante mit die Instanzvariable format in Ableitugnen dieser Klassen gesetzt werden soll.

See Also:

Constant Field Values

FORMAT_AS_TABLE

public static final int FORMAT_AS_TABLE

Konstante mit die Instanzvariable format in Ableitugnen dieser Klassen gesetzt werden soll.

See Also:

Constant Field Values

tagletHeader

protected java.lang.String tagletHeader

Enthält den Header-Output für das Custom-Taglet und muss im Konstruktor des abgeleiteten Taglet gesetzt werden.

tagletName

protected java.lang.String tagletName

Enthält den Namen des Custom-Taglets und muss im Konstruktor des abgeleiteten Taglet gesetzt werden.

Constructor Detail

AbstractTaglet

public AbstractTaglet()

Method Detail

getListFormat

public static java.lang.String getListFormat(com.sun.javadoc.Tag[] tags,
                                             java.lang.String tagletHeader)

Erzeugt für ein JavaDoc-Custom-Tag, welches von dieser Klasse abgeleitet ist, eine Parameterliste mit Beschreibungen:

Syntax: @your-tagname a-parameter-name: description

getName

public java.lang.String getName()

Liefert den Taglet-Namen aus dem Feld tagletName.

Specified by:

getName in interface com.sun.tools.doclets.Taglet

getTableFormat

public static java.lang.String getTableFormat(com.sun.javadoc.Tag[] tags,
                                              java.lang.String tagletHeader)

Erzeugt für ein JavaDoc-Custom-Tag, welches von dieser Klasse abgeleitet ist eine Tabelle mit den Spalten 'Parameter' und 'Description'.

Syntax: @your-tagname a-parameter-name: description

inConstructor

public boolean inConstructor()

Liefert false.

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Liefert false.

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Liefert false.

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Liefert false.

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Liefert false.

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Liefert true.

Specified by:

inType in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()

Liefert false.

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)

Ruft toString(Tag [] tags) mit tag als 1-elementiges Array auf.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)

Ruft in Abhängigkeit von Instanzvariable format eine der statischen Format-Methoden auf. Default-Aufruf ist getListFormat()!

Specified by:

toString in interface com.sun.tools.doclets.Taglet