org.commonmark.parser

Enum IncludeSourceSpans

java.lang.Object

java.lang.Enum<IncludeSourceSpans>

org.commonmark.parser.IncludeSourceSpans

All Implemented Interfaces:

Serializable, Comparable<IncludeSourceSpans>

public enum IncludeSourceSpans
extends Enum<IncludeSourceSpans>

Whether to include SourceSpan or not while parsing, see Parser.Builder.includeSourceSpans(IncludeSourceSpans).

Since:

0.16.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKS Include source spans on Block nodes.
BLOCKS_AND_INLINES Include source spans on block nodes and inline nodes.
NONE Do not include source spans.

Method Summary

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

NONE

public static final IncludeSourceSpans NONE

Do not include source spans.

BLOCKS

public static final IncludeSourceSpans BLOCKS

Include source spans on Block nodes.

BLOCKS_AND_INLINES

public static final IncludeSourceSpans BLOCKS_AND_INLINES

Include source spans on block nodes and inline nodes.

Method Detail

values

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

Returns:

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

valueOf

public static IncludeSourceSpans valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null