Package org.forgerock.api.markup.asciidoc

Enum Class AsciiDocSymbols

java.lang.Object

java.lang.Enum<AsciiDocSymbols>

org.forgerock.api.markup.asciidoc.AsciiDocSymbols

All Implemented Interfaces:

Serializable, Comparable<AsciiDocSymbols>, java.lang.constant.Constable

public enum AsciiDocSymbols
extends Enum<AsciiDocSymbols>

Enumeration of AsciiDoc markup symbols.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANCHOR_END	Cross-reference anchor end.
ANCHOR_START	Cross-reference anchor start.
BLOCK_TITLE	Block title.
BOLD	Bold text.
CROSS_REF_END	Cross-reference end.
CROSS_REF_START	Cross-reference start.
DOC_TITLE	Document title.
EXAMPLE	Example block.
HARDBREAKS	Hardbreaks attribute preserves line-breaks below its location in the document.
HORIZONTAL_RULE	Horizontal rule.
INCLUDE	Include-directive.
ITALIC	Italic text.
LINE_BREAK	Single line-break.
LIST_CONTINUATION	List continuation marker, for including complex markup in a list-item.
LISTING	Pre-formatted listing block.
LITERAL	Literal block.
MONO	Monospaced text.
NEWLINE	UNIX newline character.
PASSTHROUGH	Pass-through block.
SECTION_TITLE_1	Section title, level 1.
SECTION_TITLE_2	Section title, level 2.
SECTION_TITLE_3	Section title, level 3.
SECTION_TITLE_4	Section title, level 4.
SECTION_TITLE_5	Section title, level 5.
SIDEBAR	Sidebar block.
TABLE	Start/end of table.
TABLE_CELL	Table-cell delimiter.
TABLE_OF_CONTENTS	Table-of-Contents directive.
UNORDERED_LIST_1	Unordered list item at level-1.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns the AsciiDocSymbols markup symbol associated with this item.
static AsciiDocSymbols	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AsciiDocSymbols[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ANCHOR_START

public static final AsciiDocSymbols ANCHOR_START

Cross-reference anchor start.

ANCHOR_END

public static final AsciiDocSymbols ANCHOR_END

Cross-reference anchor end.

BLOCK_TITLE

public static final AsciiDocSymbols BLOCK_TITLE

Block title.

BOLD

public static final AsciiDocSymbols BOLD

Bold text.

CROSS_REF_START

public static final AsciiDocSymbols CROSS_REF_START

Cross-reference start.

CROSS_REF_END

public static final AsciiDocSymbols CROSS_REF_END

Cross-reference end.

DOC_TITLE

public static final AsciiDocSymbols DOC_TITLE

Document title.

HARDBREAKS

public static final AsciiDocSymbols HARDBREAKS

Hardbreaks attribute preserves line-breaks below its location in the document.

EXAMPLE

public static final AsciiDocSymbols EXAMPLE

Example block.

HORIZONTAL_RULE

public static final AsciiDocSymbols HORIZONTAL_RULE

Horizontal rule.

INCLUDE

public static final AsciiDocSymbols INCLUDE

Include-directive.

ITALIC

public static final AsciiDocSymbols ITALIC

Italic text.

LINE_BREAK

public static final AsciiDocSymbols LINE_BREAK

Single line-break.

LISTING

public static final AsciiDocSymbols LISTING

Pre-formatted listing block.

LIST_CONTINUATION

public static final AsciiDocSymbols LIST_CONTINUATION

List continuation marker, for including complex markup in a list-item.

LITERAL

public static final AsciiDocSymbols LITERAL

Literal block.

MONO

public static final AsciiDocSymbols MONO

Monospaced text.

UNORDERED_LIST_1

public static final AsciiDocSymbols UNORDERED_LIST_1

Unordered list item at level-1.

See Also:

• LIST_CONTINUATION

NEWLINE

public static final AsciiDocSymbols NEWLINE

UNIX newline character.

PASSTHROUGH

public static final AsciiDocSymbols PASSTHROUGH

Pass-through block.

TABLE

public static final AsciiDocSymbols TABLE

Start/end of table.

TABLE_CELL

public static final AsciiDocSymbols TABLE_CELL

Table-cell delimiter.

TABLE_OF_CONTENTS

public static final AsciiDocSymbols TABLE_OF_CONTENTS

Table-of-Contents directive.

SECTION_TITLE_1

public static final AsciiDocSymbols SECTION_TITLE_1

Section title, level 1.

SECTION_TITLE_2

public static final AsciiDocSymbols SECTION_TITLE_2

Section title, level 2.

SECTION_TITLE_3

public static final AsciiDocSymbols SECTION_TITLE_3

Section title, level 3.

SECTION_TITLE_4

public static final AsciiDocSymbols SECTION_TITLE_4

Section title, level 4.

SECTION_TITLE_5

public static final AsciiDocSymbols SECTION_TITLE_5

Section title, level 5.

SIDEBAR

public static final AsciiDocSymbols SIDEBAR

Sidebar block.

Method Details

values

public static AsciiDocSymbols[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AsciiDocSymbols valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns the AsciiDocSymbols markup symbol associated with this item.

Overrides:

toString in class Enum<AsciiDocSymbols>

Returns:

AsciiDocSymbols markup symbol