Enum Class BlockType

java.lang.Object

java.lang.Enum<BlockType>

com.github.rjeschke.txtmark.BlockType

All Implemented Interfaces:

Serializable, Comparable<BlockType>, Constable

enum BlockType
extends Enum<BlockType>

Block type enum.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKQUOTE	A block quote.
CODE	A code block.
FENCED_CODE	A fenced code block.
HEADLINE	A headline.
LIST_ITEM	A list item.
NONE	Unspecified.
ORDERED_LIST	An ordered list.
PARAGRAPH	A paragraph.
RULER	A horizontal ruler.
UNORDERED_LIST	An unordered list.
XML	A XML block.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlockType()

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final BlockType NONE

Unspecified. Used for root block and list items without paragraphs.

BLOCKQUOTE

public static final BlockType BLOCKQUOTE

A block quote.

CODE

public static final BlockType CODE

A code block.

FENCED_CODE

public static final BlockType FENCED_CODE

A fenced code block.

HEADLINE

public static final BlockType HEADLINE

A headline.

LIST_ITEM

public static final BlockType LIST_ITEM

A list item.

ORDERED_LIST

public static final BlockType ORDERED_LIST

An ordered list.

PARAGRAPH

public static final BlockType PARAGRAPH

A paragraph.

RULER

public static final BlockType RULER

A horizontal ruler.

UNORDERED_LIST

public static final BlockType UNORDERED_LIST

An unordered list.

XML

public static final BlockType XML

A XML block.

Constructor Details

BlockType

private BlockType()

Method Details

values

public static BlockType[] 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 BlockType 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