Top Description Constructors Methods
org.snakeyaml.engine.v2.events

public final Class StreamStartEvent

extends Event
Class Inheritance
Imports
java.util.Optional, org.snakeyaml.engine.v2.exceptions.Mark
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.

Constructor Summary

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

public
StreamStartEvent()

Method Summary

Modifier and TypeMethod and Description
public Event.ID
getEventId()

Implements abstract org.snakeyaml.engine.v2.events.Event.getEventId.

Get the type (kind) if this Event

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.snakeyaml.engine.v2.events.Event:
getEndMarkgetStartMark

Constructor Detail

StreamStartEventback to summary
public StreamStartEvent(Optional<Mark> startMark, Optional<Mark> endMark)
StreamStartEventback to summary
public StreamStartEvent()

Method Detail

getEventIdback 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
toStringback 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