public final Class DocumentStartEvent

Class Inheritance

extends Event

java.lang.Object
org.yaml.snakeyaml.events.Event
org.yaml.snakeyaml.events.DocumentStartEvent

Imports

java.util.Map, org.yaml.snakeyaml.DumperOptions.Version, org.yaml.snakeyaml.error.Mark

Marks the beginning of a document.

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

Field Summary

Modifier and Type	Field and Description
private final boolean	explicit
private final Map<String, String>	tags
private final DumperOptions.Version	version

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public Event.ID	getEventId() Implements abstract org.yaml.snakeyaml.events.Event.getEventId. Get the type (kind) if this Event
public boolean	Returns: true when document end is present getExplicit() getter
public Map<String, String>	Returns: Mapping of 'handles' to 'prefixes' (the handles include the '!' characters). getTags() Tag shorthands as defined by the `%TAG` directive.
public DumperOptions.Version	Returns: `null`if the document has no explicit `%YAML` directive. Otherwise an array with two components, the major and minor part of the version (in this order). getVersion() YAML version the document conforms to.

Inherited from org.yaml.snakeyaml.events.Event:: equals getArguments getEndMark getStartMark hashCode is toString

Field Detail

explicit	back to summary
private final boolean explicit

tags	back to summary
private final Map<String, String> tags

version	back to summary
private final DumperOptions.Version version

Constructor Detail

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

DocumentStartEvent

back to summary

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

Create

Parameters

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

Method Detail

getEventId	back to summary
public Event.ID getEventId() Implements abstract org.yaml.snakeyaml.events.Event.getEventId. Doc from org.yaml.snakeyaml.events.Event.getEventId. Get the type (kind) if this Event Returns:Event.ID the ID of this Event Annotations @Override

getEventId

back to summary

public Event.ID getEventId()

Implements abstract org.yaml.snakeyaml.events.Event.getEventId.

Doc from org.yaml.snakeyaml.events.Event.getEventId.

Get the type (kind) if this Event

Returns:Event.ID

the ID of this Event

Annotations

@Override

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

getExplicit

back to summary

public boolean getExplicit()

getter

Returns:boolean: true when document end is present

getTags back to summary

getTags	back to summary
public Map<String, String> getTags() Tag shorthands as defined by the `%TAG` directive. Returns:Map<String, String> Mapping of 'handles' to 'prefixes' (the handles include the '!' characters).

public Map<String, String> getTags()

Tag shorthands as defined by the %TAG directive.

Returns:Map<String, String>: Mapping of 'handles' to 'prefixes' (the handles include the '!' characters).

getVersion back to summary

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

public DumperOptions.Version getVersion()

YAML version the document conforms to.

Returns:DumperOptions.Version: 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).