org.brains2b.typewriter

Enum JavaDocTag

java.lang.Object

java.lang.Enum<JavaDocTag>

org.brains2b.typewriter.JavaDocTag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JavaDocTag>

public enum JavaDocTag
extends java.lang.Enum<JavaDocTag>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHOR
DEPRECATED
PARAM
RETURN
SEE
SERIAL
SINCE
THROWS
VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTag()
static JavaDocTag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JavaDocTag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHOR

public static final JavaDocTag AUTHOR

DEPRECATED

public static final JavaDocTag DEPRECATED

PARAM

public static final JavaDocTag PARAM

RETURN

public static final JavaDocTag RETURN

SEE

public static final JavaDocTag SEE

SERIAL

public static final JavaDocTag SERIAL

SINCE

public static final JavaDocTag SINCE

THROWS

public static final JavaDocTag THROWS

VERSION

public static final JavaDocTag VERSION

Method Detail

values

public static JavaDocTag[] 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 (JavaDocTag c : JavaDocTag.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavaDocTag valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getTag

public java.lang.String getTag()