com.github.chhorz.javadoc

Enum OutputType

java.lang.Object

java.lang.Enum<OutputType>

com.github.chhorz.javadoc.OutputType

All Implemented Interfaces:

Serializable, Comparable<OutputType>

public enum OutputType
extends Enum<OutputType>

Supported output types for the parsed JavaDoc content.

Author:

chhorz

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCIIDOC
HTML
MARKDOWN
PLAIN

Method Summary

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

ASCIIDOC

public static final OutputType ASCIIDOC

HTML

public static final OutputType HTML

MARKDOWN

public static final OutputType MARKDOWN

PLAIN

public static final OutputType PLAIN

Method Detail

values

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

Returns:

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

valueOf

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