org.asciidoctor.extension

Enum LocationType

java.lang.Object

java.lang.Enum<LocationType>

org.asciidoctor.extension.LocationType

All Implemented Interfaces:

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

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

Location used by the Location annotation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOOTER
HEADER

Method Summary

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

HEADER

public static final LocationType HEADER

FOOTER

public static final LocationType FOOTER

Method Detail

values

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

Returns:

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

valueOf

public static LocationType 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()