Top Description Fields Constructors Methods
org.yaml.snakeyaml.events

public final Class CommentEvent

extends Event
Class Inheritance
Imports
org.yaml.snakeyaml.comments.CommentType, org.yaml.snakeyaml.error.Mark
Marks a comment block value.

Field Summary

Modifier and TypeField and Description
private final CommentType
type

private final String
value

Constructor Summary

AccessConstructor and Description
public
CommentEvent(CommentType
- kind
type, String
- text
value, Mark
- start
startMark, Mark
- end
endMark)

Create

Method Summary

Modifier and TypeMethod and Description
protected String
getArguments()

Overrides org.yaml.snakeyaml.events.Event.getArguments.

Generate human readable representation of the Event
public CommentType

Returns:

the commentType.
getCommentType()

The comment type.

public Event.ID
getEventId()

Implements abstract org.yaml.snakeyaml.events.Event.getEventId.

Get the type (kind) if this Event
public String

Returns:

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

String representation of the value.

Inherited from org.yaml.snakeyaml.events.Event:
equalsgetEndMarkgetStartMarkhashCodeistoString

Field Detail

typeback to summary
private final CommentType type
valueback to summary
private final String value

Constructor Detail

CommentEventback to summary
public CommentEvent(CommentType type, String value, Mark startMark, Mark endMark)

Create

Parameters
type:CommentType

- kind

value:String

- text

startMark:Mark

- start

endMark:Mark

- end

Method Detail

getArgumentsback to summary
protected String getArguments()

Overrides org.yaml.snakeyaml.events.Event.getArguments.

Doc from org.yaml.snakeyaml.events.Event.getArguments.

Generate human readable representation of the Event

Returns:String

representation fore humans

Annotations
@Override
getCommentTypeback to summary
public CommentType getCommentType()

The comment type.

Returns:CommentType

the commentType.

getEventIdback to summary
public Event.ID getEventId()

Implements abstract org.yaml.snakeyaml.events.Event.getEventId.

Doc from org.yaml.snakeyaml.events.Event.getEventId.

Get the type (kind) if this Event

Returns:Event.ID

the ID of this Event

Annotations
@Override
getValueback to summary
public String getValue()

String representation of the value.

Without quotes and escaping.

Returns:String

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