CommentEvent (SnakeYAML Engine 2.3 API)

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 org.snakeyaml.engine.v2.events.Event
  Event.ID

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
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 org.snakeyaml.engine.v2.events.Event
getEndMark, getStartMark

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CommentEvent
```
public CommentEvent(CommentType type,
                    String value,
                    Optional<Mark> startMark,
                    Optional<Mark> endMark)
```
- Method Detail
  - 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