Package org.commonmark.parser
Enum IncludeSourceSpans
- java.lang.Object
-
- java.lang.Enum<IncludeSourceSpans>
-
- org.commonmark.parser.IncludeSourceSpans
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<IncludeSourceSpans>
public enum IncludeSourceSpans extends java.lang.Enum<IncludeSourceSpans>
Whether to includeSourceSpan
or not while parsing, seeParser.Builder.includeSourceSpans(IncludeSourceSpans)
.- Since:
- 0.16.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BLOCKS
Include source spans onBlock
nodes.BLOCKS_AND_INLINES
Include source spans on block nodes and inline nodes.NONE
Do not include source spans.
-
Constructor Summary
Constructors Modifier Constructor Description private
IncludeSourceSpans()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static IncludeSourceSpans
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
NONE
public static final IncludeSourceSpans NONE
Do not include source spans.
-
BLOCKS
public static final IncludeSourceSpans BLOCKS
Include source spans onBlock
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(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 namejava.lang.NullPointerException
- if the argument is null
-
-