org.asciidoctor.extension

Enum FormatType

java.lang.Object

java.lang.Enum<FormatType>

org.asciidoctor.extension.FormatType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FormatType>

public enum FormatType
extends java.lang.Enum<FormatType>

Inline macro format used by the Format annotation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM
LONG
SHORT

Method Summary

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

LONG

public static final FormatType LONG

SHORT

public static final FormatType SHORT

CUSTOM

public static final FormatType CUSTOM

Method Detail

values

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

Returns:

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

valueOf

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

optionValue

public java.lang.String optionValue()