com.github.therapi.runtimejavadoc

Enum SeeAlsoJavadoc.SeeAlsoType

java.lang.Object

java.lang.Enum<SeeAlsoJavadoc.SeeAlsoType>

com.github.therapi.runtimejavadoc.SeeAlsoJavadoc.SeeAlsoType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SeeAlsoJavadoc.SeeAlsoType>

Enclosing class:

SeeAlsoJavadoc

public static enum SeeAlsoJavadoc.SeeAlsoType
extends java.lang.Enum<SeeAlsoJavadoc.SeeAlsoType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML_LINK
JAVADOC_LINK
STRING_LITERAL

Method Summary

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

STRING_LITERAL

public static final SeeAlsoJavadoc.SeeAlsoType STRING_LITERAL

HTML_LINK

public static final SeeAlsoJavadoc.SeeAlsoType HTML_LINK

JAVADOC_LINK

public static final SeeAlsoJavadoc.SeeAlsoType JAVADOC_LINK

Method Detail

values

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

Returns:

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

valueOf

public static SeeAlsoJavadoc.SeeAlsoType 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