SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.events.DocumentStartEvent

Field Summary

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

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

Modifier and Type	Method and Description
public Event.ID	getEventId() Implements abstract org.snakeyaml.engine.v2.events.Event.getEventId. Get the type (kind) if this Event
public Optional<SpecVersion>	Returns: YAML version the document conforms to. getSpecVersion()
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 boolean	isExplicit()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.snakeyaml.engine.v2.events.Event:: getEndMark getStartMark

explicit	back to summary
private final boolean explicit

specVersion	back to summary
private final Optional<SpecVersion> specVersion

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

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

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

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

getEventId

public Event.ID getEventId()

Get the type (kind) if this Event

Annotations

getSpecVersion	back to summary
public Optional<SpecVersion> getSpecVersion() Returns:Optional<SpecVersion> YAML version the document conforms to.

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

isExplicit	back to summary
public boolean isExplicit()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations