Enum IncludeSourceSpans

java.lang.Object
java.lang.Enum<IncludeSourceSpans>
org.commonmark.parser.IncludeSourceSpans
All Implemented Interfaces:
Serializable, Comparable<IncludeSourceSpans>, java.lang.constant.Constable

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 Details

    • 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.
  • Constructor Details

    • IncludeSourceSpans

      private IncludeSourceSpans()
  • Method Details

    • values

      public static IncludeSourceSpans[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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