org.snakeyaml.engine.v2.events

Class StreamStartEvent

java.lang.Object

org.snakeyaml.engine.v2.events.Event

org.snakeyaml.engine.v2.events.StreamStartEvent

public final class StreamStartEvent
extends Event

Marks the start of a stream that might contain multiple documents.

This event is the first event that a parser emits. Together with StreamEndEvent (which is the last event a parser emits) they mark the beginning and the end of a stream of documents.

See Event for an exemplary output.

Nested Class Summary

Nested classes/interfaces inherited from class org.snakeyaml.engine.v2.events.Event

Event.ID

Constructor Summary

Constructors

Constructor and Description
StreamStartEvent()
StreamStartEvent(Optional<Mark> startMark, Optional<Mark> endMark)

Method Summary

Modifier and Type	Method and Description
Event.ID	getEventId()
String	toString()

Methods inherited from class org.snakeyaml.engine.v2.events.Event

equals, getEndMark, getStartMark, hashCode, isEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamStartEvent

public StreamStartEvent(Optional<Mark> startMark,
                        Optional<Mark> endMark)

StreamStartEvent

public StreamStartEvent()

Method Detail

getEventId

public Event.ID getEventId()

Specified by:

getEventId in class Event

toString

public String toString()

Overrides:

toString in class Object