Class DocumentStartEvent


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

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

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.snakeyaml.engine.v2.events.Event

        Event.ID
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean explicit  
      private java.util.Optional<SpecVersion> specVersion  
      private java.util.Map<java.lang.String,​java.lang.String> tags  
    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentStartEvent​(boolean explicit, java.util.Optional<SpecVersion> specVersion, java.util.Map<java.lang.String,​java.lang.String> tags)  
      DocumentStartEvent​(boolean explicit, java.util.Optional<SpecVersion> specVersion, java.util.Map<java.lang.String,​java.lang.String> tags, java.util.Optional<Mark> startMark, java.util.Optional<Mark> endMark)  
    • Field Detail

      • explicit

        private final boolean explicit
      • specVersion

        private final java.util.Optional<SpecVersion> specVersion
      • tags

        private final java.util.Map<java.lang.String,​java.lang.String> tags
    • Constructor Detail

      • DocumentStartEvent

        public DocumentStartEvent​(boolean explicit,
                                  java.util.Optional<SpecVersion> specVersion,
                                  java.util.Map<java.lang.String,​java.lang.String> tags,
                                  java.util.Optional<Mark> startMark,
                                  java.util.Optional<Mark> endMark)
      • DocumentStartEvent

        public DocumentStartEvent​(boolean explicit,
                                  java.util.Optional<SpecVersion> specVersion,
                                  java.util.Map<java.lang.String,​java.lang.String> tags)
    • Method Detail

      • isExplicit

        public boolean isExplicit()
      • getSpecVersion

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

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object