Package org.yaml.snakeyaml.events

Class DocumentStartEvent

java.lang.Object
org.yaml.snakeyaml.events.Event
org.yaml.snakeyaml.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.

  • Constructor Details

    • DocumentStartEvent

      public DocumentStartEvent(Mark startMark, Mark endMark, boolean explicit, DumperOptions.Version version, Map<String,String> tags)
      Create
      Parameters:
      startMark - - start
      endMark - - end
      explicit - - true when it is present in the document
      version - - YAML version
      tags - - tag directives

  • Method Details

    • getExplicit

      public boolean getExplicit()
      getter
      Returns:
      true when document end is present

    • getVersion

      public DumperOptions.Version getVersion()
      YAML version the document conforms to.
      Returns:
      nullif the document has no explicit %YAML directive. Otherwise an array with two components, the major and minor part of the version (in this order).

    • 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