Modifier and Type	Class and Description
public static enum	Event.ID Event types

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

Access	Constructor and Description
public	Event(Mark - start startMark, Mark - end endMark) Create

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
protected String	Returns: representation fore humans getArguments() Generate human readable representation of the Event
public Mark	Returns: end getEndMark() getter
public abstract Event.ID	Returns: the ID of this Event getEventId() Get the type (kind) if this Event
public Mark	Returns: start getStartMark() getter
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: true then this Event of the provided type is(Event.ID - the Event.ID enum id) Check if the Event is of the provided kind
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

endMark	back to summary
private final Mark endMark

startMark	back to summary
private final Mark startMark

Constructor Detail

Event	back to summary
public Event(Mark startMark, Mark endMark) Create Parameters startMark:Mark - start endMark:Mark - end

Event

back to summary

public Event(Mark startMark, Mark endMark)

Create

Parameters

startMark:Mark: - start
endMark:Mark: - end

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getArguments back to summary

getArguments	back to summary
protected String getArguments() Generate human readable representation of the Event Returns:String representation fore humans See Also `for Event in PyYAML"`

protected String getArguments()

Generate human readable representation of the Event

Returns:String: representation fore humans
See Also: for Event in PyYAML"

getEndMark	back to summary
public Mark getEndMark() getter Returns:Mark end

getEndMark

back to summary

public Mark getEndMark()

getter

Returns:Mark: end

getEventId	back to summary
public abstract Event.ID getEventId() Get the type (kind) if this Event Returns:Event.ID the ID of this Event

getEventId

back to summary

public abstract Event.ID getEventId()

Get the type (kind) if this Event

Returns:Event.ID: the ID of this Event

getStartMark	back to summary
public Mark getStartMark() getter Returns:Mark start

getStartMark

back to summary

public Mark getStartMark()

getter

Returns:Mark: start

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

is	back to summary
public boolean is(Event.ID id) Check if the Event is of the provided kind Parameters id:Event.ID - the Event.ID enum Returns:boolean true then this Event of the provided type

back to summary

public boolean is(Event.ID id)

Check if the Event is of the provided kind

Parameters

id:Event.ID: - the Event.ID enum

Returns:boolean

true then this Event of the provided type

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. Returns:String a string representation of the object.

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.

Returns:String: a string representation of the object.

org.yaml.snakeyaml.events back to summary

public final Enum Event.ID

Class Inheritance

extends Enum<Event.ID>

java.lang.Object
java.lang.Enum
org.yaml.snakeyaml.events.Event.ID

Event types

Field Summary

Modifier and Type	Field 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

Access	Constructor and Description
private	ID()

Method Summary

Modifier and Type	Method and Description
public static Event.ID	valueOf(String name)
public static Event.ID[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Alias	back to summary
public static final Event.ID Alias

Comment	back to summary
public static final Event.ID Comment

DocumentEnd	back to summary
public static final Event.ID DocumentEnd

DocumentStart	back to summary
public static final Event.ID DocumentStart

MappingEnd	back to summary
public static final Event.ID MappingEnd

MappingStart	back to summary
public static final Event.ID MappingStart

Scalar	back to summary
public static final Event.ID Scalar

SequenceEnd	back to summary
public static final Event.ID SequenceEnd

SequenceStart	back to summary
public static final Event.ID SequenceStart

StreamEnd	back to summary
public static final Event.ID StreamEnd

StreamStart	back to summary
public static final Event.ID StreamStart

Constructor Detail

ID	back to summary
private ID()

Method Detail

valueOf	back to summary
public static Event.ID valueOf(String name)

values	back to summary
public static Event.ID[] values()

public abstract Class Event

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Event.ID

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail