com.github.javaparser.javadoc.description

Enum JavadocInlineTag.Type

java.lang.Object

java.lang.Enum<JavadocInlineTag.Type>

com.github.javaparser.javadoc.description.JavadocInlineTag.Type

All Implemented Interfaces:

Serializable, Comparable<JavadocInlineTag.Type>

Enclosing class:

JavadocInlineTag

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE
DOC_ROOT
INHERIT_DOC
LINK
LINKPLAIN
LITERAL
SYSTEM_PROPERTY
UNKNOWN
VALUE

Method Summary

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

CODE

public static final JavadocInlineTag.Type CODE

DOC_ROOT

public static final JavadocInlineTag.Type DOC_ROOT

INHERIT_DOC

public static final JavadocInlineTag.Type INHERIT_DOC

LINK

public static final JavadocInlineTag.Type LINK

LINKPLAIN

public static final JavadocInlineTag.Type LINKPLAIN

LITERAL

public static final JavadocInlineTag.Type LITERAL

VALUE

public static final JavadocInlineTag.Type VALUE

SYSTEM_PROPERTY

public static final JavadocInlineTag.Type SYSTEM_PROPERTY

UNKNOWN

public static final JavadocInlineTag.Type UNKNOWN

Method Detail

values

public static JavadocInlineTag.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 (JavadocInlineTag.Type c : JavadocInlineTag.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 JavadocInlineTag.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