org.nuxeo.apidoc.documentation

Enum DefaultDocumentationType

java.lang.Object

java.lang.Enum<DefaultDocumentationType>

org.nuxeo.apidoc.documentation.DefaultDocumentationType

All Implemented Interfaces:

Serializable, Comparable<DefaultDocumentationType>

public enum DefaultDocumentationType
extends Enum<DefaultDocumentationType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE_SAMPLE
DESCRIPTION
HOW_TO

Method Summary

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DESCRIPTION

public static final DefaultDocumentationType DESCRIPTION

CODE_SAMPLE

public static final DefaultDocumentationType CODE_SAMPLE

HOW_TO

public static final DefaultDocumentationType HOW_TO

Method Detail

values

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

Returns:

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

valueOf

public static DefaultDocumentationType 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<DefaultDocumentationType>