Class CommentLine

java.lang.Object

org.snakeyaml.engine.v2.comments.CommentLine

public class CommentLine
extends Object

A comment line. Maybe a block comment, blank line, or inline comment.

Field Summary

Fields

Modifier and Type	Field	Description
private final CommentType	commentType
private final Optional<Mark>	endMark
private final Optional<Mark>	startMark
private final String	value

Constructor Summary

Constructors

Constructor	Description
CommentLine(Optional<Mark> startMark, Optional<Mark> endMark, String value, CommentType commentType)	Create
CommentLine(CommentEvent event)	Create

Method Summary

Modifier and Type	Method	Description
CommentType	getCommentType()	getter
Optional<Mark>	getEndMark()	getter
Optional<Mark>	getStartMark()	getter
String	getValue()	Value of this comment.
String	toString()

Methods inherited from class Object

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

Field Details

startMark

private final Optional<Mark> startMark

endMark

private final Optional<Mark> endMark

value

private final String value

commentType

private final CommentType commentType

Constructor Details

CommentLine

public CommentLine(CommentEvent event)

Create

Parameters:

event - - the source

CommentLine

public CommentLine(Optional<Mark> startMark,
 Optional<Mark> endMark,
 String value,
 CommentType commentType)

Create

Parameters:

startMark - - start

endMark - - end

value - - the comment

commentType - - the type

Method Details

getEndMark

public Optional<Mark> getEndMark()

getter

Returns:

end position

getStartMark

public Optional<Mark> getStartMark()

getter

Returns:

start position

getCommentType

public CommentType getCommentType()

getter

Returns:

type of it

getValue

public String getValue()

Value of this comment.

Returns:

comment's value.

toString

public String toString()

Overrides:

toString in class Object