org.yaml.snakeyaml.events

Class Event

java.lang.Object

org.yaml.snakeyaml.events.Event

Direct Known Subclasses:

CollectionEndEvent, CommentEvent, DocumentEndEvent, DocumentStartEvent, NodeEvent, StreamEndEvent, StreamStartEvent

public abstract class Event
extends java.lang.Object

Basic unit of output from a Parser or input of a Emitter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.ID

Field Summary

Fields

Modifier and Type	Field and Description
private Mark	endMark
private Mark	startMark

Constructor Summary

Constructors

Constructor and Description
Event(Mark startMark, Mark endMark)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected java.lang.String	getArguments() Generate human readable representation of the Event
Mark	getEndMark()
abstract Event.ID	getEventId() Get the type (kind) if this Event
Mark	getStartMark()
int	hashCode()
boolean	is(Event.ID id) Check if the Event is of the provided kind
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

startMark

private final Mark startMark

endMark

private final Mark endMark

Constructor Detail

Event

public Event(Mark startMark,
             Mark endMark)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStartMark

public Mark getStartMark()

getEndMark

public Mark getEndMark()

getArguments

protected java.lang.String getArguments()

Generate human readable representation of the Event

Returns:

representation fore humans

See Also:

"__repr__ for Event in PyYAML"

is

public boolean is(Event.ID id)

Check if the Event is of the provided kind

Parameters:

id - - the Event.ID enum

Returns:

true then this Event of the provided type

getEventId

public abstract Event.ID getEventId()

Get the type (kind) if this Event

Returns:

the ID of this Event

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object