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.

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.ID

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	explicit
private final Optional<SpecVersion>	specVersion
private final Map<String,String>	tags

Constructor Summary

Constructors

Constructor	Description
DocumentStartEvent(boolean explicit, Optional<SpecVersion> specVersion, Map<String,String> tags)
DocumentStartEvent(boolean explicit, Optional<SpecVersion> specVersion, Map<String,String> tags, Optional<Mark> startMark, Optional<Mark> endMark)

Method Summary

Modifier and Type	Method	Description
Event.ID	getEventId()	Get the type (kind) if this Event
Optional<SpecVersion>	getSpecVersion()
Map<String,String>	getTags()	Tag shorthands as defined by the %TAG directive.
boolean	isExplicit()
String	toString()

Methods inherited from class Event

getEndMark, getStartMark

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

explicit

private final boolean explicit

specVersion

private final Optional<SpecVersion> specVersion

tags

private final Map<String,String> tags

Constructor Details

DocumentStartEvent

public DocumentStartEvent(boolean explicit,
 Optional<SpecVersion> specVersion,
 Map<String,String> tags,
 Optional<Mark> startMark,
 Optional<Mark> endMark)

DocumentStartEvent

public DocumentStartEvent(boolean explicit,
 Optional<SpecVersion> specVersion,
 Map<String,String> tags)

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