Class DocumentStartEvent

java.lang.Object
org.snakeyaml.engine.v2.events.Event
org.snakeyaml.engine.v2.events.DocumentStartEvent

public final class DocumentStartEvent extends Event
Marks the beginning of a document.

This event followed by the document's content and a DocumentEndEvent.

  • Field Details

  • Constructor Details

  • Method Details

    • isExplicit

      public boolean isExplicit()
    • getSpecVersion

      public Optional<SpecVersion> getSpecVersion()
      Returns:
      YAML version the document conforms to.
    • getTags

      public Map<String,String> getTags()
      Tag shorthands as defined by the %TAG directive.
      Returns:
      Mapping of 'handles' to 'prefixes' (the handles include the '!' characters).
    • getEventId

      public Event.ID getEventId()
      Description copied from class: Event
      Get the type (kind) if this Event
      Specified by:
      getEventId in class Event
      Returns:
      the ID of this Event
    • toString

      public String toString()
      Overrides:
      toString in class Object