Class CommentEvent

java.lang.Object

org.snakeyaml.engine.v2.events.Event

org.snakeyaml.engine.v2.events.CommentEvent

public final class CommentEvent
extends Event

Marks a comment block value.

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.ID

Field Summary

Fields

Modifier and Type	Field	Description
private final CommentType	type
private final String	value

Constructor Summary

Constructors

Constructor	Description
CommentEvent(CommentType type, String value, Optional<Mark> startMark, Optional<Mark> endMark)

Method Summary

Modifier and Type	Method	Description
CommentType	getCommentType()	The comment type.
Event.ID	getEventId()	Get the type (kind) if this Event
String	getValue()	String representation of the value.
String	toString()

Methods inherited from class Event

getEndMark, getStartMark

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

type

private final CommentType type

value

private final String value

Constructor Details

CommentEvent

public CommentEvent(CommentType type,
 String value,
 Optional<Mark> startMark,
 Optional<Mark> endMark)

Method Details

getValue

public String getValue()

String representation of the value.

Without quotes and escaping.

Returns:

Value a comment line string without the leading '#' or a blank line.

getCommentType

public CommentType getCommentType()

The comment type.

Returns:

the commentType.

getEventId

public Event.ID getEventId()

Description copied from class: Event

Get the type (kind) if this Event

Specified by:

getEventId in class Event

Returns:

the ID of this Event

toString

public String toString()

Overrides:

toString in class Object