org.asciidoctor

Enum Placement

java.lang.Object

java.lang.Enum<Placement>

org.asciidoctor.Placement

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM
LEFT
MACRO
PREAMBLE
RIGHT
TOP

Method Summary

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

TOP

public static final Placement TOP

BOTTOM

public static final Placement BOTTOM

LEFT

public static final Placement LEFT

RIGHT

public static final Placement RIGHT

PREAMBLE

public static final Placement PREAMBLE

MACRO

public static final Placement MACRO

Method Detail

values

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

Returns:

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

valueOf

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

getPosition

public java.lang.String getPosition()