Package org.yaml.snakeyaml.tokens

Class CommentToken

java.lang.Object

org.yaml.snakeyaml.tokens.Token

org.yaml.snakeyaml.tokens.CommentToken

public final class CommentToken
extends Token

Comment for humans

Nested Class Summary

Nested classes/interfaces inherited from class org.yaml.snakeyaml.tokens.Token

Token.ID

Constructor Summary

Constructors

Constructor	Description
CommentToken(CommentType type, String value, Mark startMark, Mark endMark)	Create

Method Summary

Modifier and Type	Method	Description
CommentType	getCommentType()	getter
Token.ID	getTokenId()	For error reporting.
String	getValue()	getter

Methods inherited from class org.yaml.snakeyaml.tokens.Token

getEndMark, getStartMark

Methods inherited from class java.lang.Object

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

Constructor Details

CommentToken

public CommentToken(CommentType type,
 String value,
 Mark startMark,
 Mark endMark)

Create

Parameters:

type - - kind

value - - text

startMark - - start

endMark - - end

Method Details

getCommentType

public CommentType getCommentType()

getter

Returns:

the kind

getValue

public String getValue()

getter

Returns:

text

getTokenId

public Token.ID getTokenId()

Description copied from class: Token

For error reporting.

Specified by:

getTokenId in class Token

Returns:

ID of this token

See Also:

• "class variable 'id' in PyYAML"