Package org.yaml.snakeyaml.comments

Class CommentLine

java.lang.Object

org.yaml.snakeyaml.comments.CommentLine

public class CommentLine
extends Object

A comment line. It may be a block comment, blank line, or inline comment.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

startMark

private final Mark startMark

endMark

private final 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(Mark startMark,
 Mark endMark,
 String value,
 CommentType commentType)

Create

Parameters:

startMark - - start

endMark - - end

value - - text

commentType - - kind

Method Details

getEndMark

public Mark getEndMark()

getter

Returns:

end

getStartMark

public Mark getStartMark()

getter

Returns:

start

getCommentType

public CommentType getCommentType()

Getter

Returns:

kind

getValue

public String getValue()

Value of this comment.

Returns:

comment's value.

toString

public String toString()

Overrides:

toString in class Object