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

public final Class CommentToken

extends Token
Class Inheritance
Imports
java.util.Objects, org.yaml.snakeyaml.comments.CommentType, org.yaml.snakeyaml.error.Mark
Comment for humans

Field Summary

Modifier and TypeField and Description
private final CommentType
type

private final String
value

Constructor Summary

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

Create

Method Summary

Modifier and TypeMethod and Description
public CommentType

Returns:

the kind
getCommentType()

getter

public Token.ID
getTokenId()

Implements abstract org.yaml.snakeyaml.tokens.Token.getTokenId.

For error reporting.
public String

Returns:

text
getValue()

getter

Inherited from org.yaml.snakeyaml.tokens.Token:
getEndMarkgetStartMark

Field Detail

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

Constructor Detail

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

Create

Parameters
type:CommentType

- kind

value:String

- text

startMark:Mark

- start

endMark:Mark

- end

Method Detail

getCommentTypeback to summary
public CommentType getCommentType()

getter

Returns:CommentType

the kind

getTokenIdback to summary
public Token.ID getTokenId()

Implements abstract org.yaml.snakeyaml.tokens.Token.getTokenId.

Doc from org.yaml.snakeyaml.tokens.Token.getTokenId.

For error reporting.

Returns:Token.ID

ID of this token

Annotations
@Override
getValueback to summary
public String getValue()

getter

Returns:String

text