org.weborganic.xmldoclet
Enum BlockTag

java.lang.Object
  java.lang.Enum<BlockTag>
      org.weborganic.xmldoclet.BlockTag

All Implemented Interfaces:

com.sun.tools.doclets.Taglet, Serializable, Comparable<BlockTag>

public enum BlockTag
extends Enum<BlockTag>
implements com.sun.tools.doclets.Taglet

A collection of taglets to support the standard javadoc tags.

Enum Constant Summary

AUTHOR
Taglet for the @author tag.

DEPRECATED

SERIAL

SERIALDATA

SERIALFIELD

SINCE

VERSION

Method Summary

String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
abstract XMLNode	toXMLNode(Tag tag) Returns the XML node corresponding to this taglet.
static BlockTag	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlockTag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.Taglet

toString, toString

Enum Constant Detail

AUTHOR

public static final BlockTag AUTHOR

Taglet for the @author tag.

DEPRECATED

public static final BlockTag DEPRECATED

SERIAL

public static final BlockTag SERIAL

SERIALDATA

public static final BlockTag SERIALDATA

SERIALFIELD

public static final BlockTag SERIALFIELD

SINCE

public static final BlockTag SINCE

VERSION

public static final BlockTag VERSION

Method Detail

values

public static BlockTag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BlockTag c : BlockTag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BlockTag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toXMLNode

public abstract XMLNode toXMLNode(Tag tag)

Returns the XML node corresponding to this taglet.

getName

public String getName()

Specified by:

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

isInlineTag

public boolean isInlineTag()

Specified by:

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

inConstructor

public boolean inConstructor()

Specified by:

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

inField

public boolean inField()

Specified by:

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

inMethod

public boolean inMethod()

Specified by:

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

inOverview

public boolean inOverview()

Specified by:

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

inPackage

public boolean inPackage()

Specified by:

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

inType

public boolean inType()

Specified by:

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