Package com.github.javaparser.javadoc

Enum JavadocBlockTag.Type

java.lang.Object

java.lang.Enum<JavadocBlockTag.Type>

com.github.javaparser.javadoc.JavadocBlockTag.Type

All Implemented Interfaces:

Serializable, Comparable<JavadocBlockTag.Type>

Enclosing class:

JavadocBlockTag

public static enum JavadocBlockTag.Type
extends Enum<JavadocBlockTag.Type>

The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHOR
DEPRECATED
EXCEPTION
PARAM
RETURN
SEE
SERIAL
SERIAL_DATA
SERIAL_FIELD
SINCE
THROWS
UNKNOWN
VERSION

Method Summary

Modifier and Type	Method	Description
static JavadocBlockTag.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JavadocBlockTag.Type[]	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 JavadocBlockTag.Type AUTHOR

DEPRECATED

public static final JavadocBlockTag.Type DEPRECATED

EXCEPTION

public static final JavadocBlockTag.Type EXCEPTION

PARAM

public static final JavadocBlockTag.Type PARAM

RETURN

public static final JavadocBlockTag.Type RETURN

SEE

public static final JavadocBlockTag.Type SEE

SERIAL

public static final JavadocBlockTag.Type SERIAL

SERIAL_DATA

public static final JavadocBlockTag.Type SERIAL_DATA

SERIAL_FIELD

public static final JavadocBlockTag.Type SERIAL_FIELD

SINCE

public static final JavadocBlockTag.Type SINCE

THROWS

public static final JavadocBlockTag.Type THROWS

VERSION

public static final JavadocBlockTag.Type VERSION

UNKNOWN

public static final JavadocBlockTag.Type UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static JavadocBlockTag.Type 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