java.lang.Object

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.

Nested Class Summary

Nested classes/interfaces inherited from class org.yaml.snakeyaml.events.Event
Event.ID

Constructor Summary

Constructors
Constructor	Description
`DocumentStartEvent(Mark startMark, Mark endMark, boolean explicit, DumperOptions.Version version, java.util.Map<java.lang.String,java.lang.String> tags)`

Method Summary

Modifier and Type	Method	Description
`Event.ID`	`getEventId()`	Get the type (kind) if this Event
`boolean`	`getExplicit()`
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()`	Tag shorthands as defined by the `%TAG` directive.
`DumperOptions.Version`	`getVersion()`	YAML version the document conforms to.

equals, getArguments, getEndMark, getStartMark, hashCode, is, toString

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- DocumentStartEvent
  
  public DocumentStartEvent(Mark startMark, Mark endMark, boolean explicit, DumperOptions.Version version, java.util.Map<java.lang.String,java.lang.String> tags)
Method Details
- getExplicit
  
  public boolean getExplicit()
- 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 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