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.

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
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.
boolean	is(Event.ID id)

Methods inherited from class org.yaml.snakeyaml.events.Event

equals, getArguments, getEndMark, getStartMark, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentStartEvent

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

Method Detail

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).

is

public boolean is(Event.ID id)

Specified by:

is in class Event