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

public abstract Class Event

extends Object
Class Inheritance
Known Direct Subclasses
org.snakeyaml.engine.v2.events.NodeEvent, org.snakeyaml.engine.v2.events.StreamEndEvent, org.snakeyaml.engine.v2.events.StreamStartEvent, org.snakeyaml.engine.v2.events.CollectionEndEvent, org.snakeyaml.engine.v2.events.CommentEvent, org.snakeyaml.engine.v2.events.DocumentEndEvent, org.snakeyaml.engine.v2.events.DocumentStartEvent
Imports
java.util.Optional, org.snakeyaml.engine.v2.exceptions.Mark
Basic unit of output from a org.snakeyaml.engine.v2.parser.Parser or input of a org.snakeyaml.engine.v2.emitter.Emitter.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Event.ID

ID of a non-abstract Event

Field Summary

Modifier and TypeField and Description
private final Optional<Mark>
endMark

private final Optional<Mark>
startMark

Constructor Summary

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

public
Event()

Method Summary

Modifier and TypeMethod and Description
public Optional<Mark>
getEndMark()

public abstract Event.ID

Returns:

the ID of this Event
getEventId()

Get the type (kind) if this Event

public Optional<Mark>
getStartMark()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

endMarkback to summary
private final Optional<Mark> endMark
startMarkback to summary
private final Optional<Mark> startMark

Constructor Detail

Eventback to summary
public Event(Optional<Mark> startMark, Optional<Mark> endMark)
Eventback to summary
public Event()

Method Detail

getEndMarkback to summary
public Optional<Mark> getEndMark()
getEventIdback to summary
public abstract Event.ID getEventId()

Get the type (kind) if this Event

Returns:Event.ID

the ID of this Event

getStartMarkback to summary
public Optional<Mark> getStartMark()
org.snakeyaml.engine.v2.events back to summary

public final Enum Event.ID

extends Enum<Event.ID>
Class Inheritance
ID of a non-abstract Event

Field Summary

Modifier and TypeField and Description
public static final Event.ID
Alias

public static final Event.ID
Comment

public static final Event.ID
DocumentEnd

public static final Event.ID
DocumentStart

public static final Event.ID
MappingEnd

public static final Event.ID
MappingStart

public static final Event.ID
Scalar

public static final Event.ID
SequenceEnd

public static final Event.ID
SequenceStart

public static final Event.ID
StreamEnd

public static final Event.ID
StreamStart

Constructor Summary

AccessConstructor and Description
private
ID()

Method Summary

Modifier and TypeMethod and Description
public static Event.ID
valueOf(String name)

public static Event.ID[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Aliasback to summary
public static final Event.ID Alias
Commentback to summary
public static final Event.ID Comment
DocumentEndback to summary
public static final Event.ID DocumentEnd
DocumentStartback to summary
public static final Event.ID DocumentStart
MappingEndback to summary
public static final Event.ID MappingEnd
MappingStartback to summary
public static final Event.ID MappingStart
Scalarback to summary
public static final Event.ID Scalar
SequenceEndback to summary
public static final Event.ID SequenceEnd
SequenceStartback to summary
public static final Event.ID SequenceStart
StreamEndback to summary
public static final Event.ID StreamEnd
StreamStartback to summary
public static final Event.ID StreamStart

Constructor Detail

IDback to summary
private ID()

Method Detail

valueOfback to summary
public static Event.ID valueOf(String name)
valuesback to summary
public static Event.ID[] values()