Package org.yaml.snakeyaml.scanner

Interface Scanner

All Known Implementing Classes:

ScannerImpl

public interface Scanner

This interface represents an input stream of Tokens.

The parser and the scanner form together the 'Parse' step in the loading process (see chapter 3.1 of the YAML Specification).

See Also:

Token

Method Summary

Modifier and Type	Method	Description
default boolean	checkToken(Token.ID choice)	Check if the next token is the given type.
boolean	checkToken(Token.ID... choices)	Check if the next token is one of the given types.
Token	getToken()	Returns the next token.
Token	peekToken()	Return the next token, but do not delete it from the stream.
void	resetDocumentIndex()

Method Detail

checkToken

boolean checkToken(Token.ID... choices)

Check if the next token is one of the given types.

Parameters:

choices - token IDs to match with

Returns:

true if the next token is one of the given types. Returns false if no more tokens are available.

Throws:

ScannerException - Thrown in case of malformed input.

checkToken

default boolean checkToken(Token.ID choice)

Check if the next token is the given type.

Parameters:

choice - token ID to match with

Returns:

true if the next token is the given type. Returns false if no more tokens are available.

Throws:

ScannerException - Thrown in case of malformed input.

peekToken

Token peekToken()

Return the next token, but do not delete it from the stream.

Returns:

The token that will be returned on the next call to getToken()

Throws:

ScannerException - Thrown in case of malformed input.

IndexOutOfBoundsException - if no more token left

getToken

Token getToken()

Returns the next token.

The token will be removed from the stream. (Every invocation of this method must happen after calling either checkToken(org.yaml.snakeyaml.tokens.Token.ID...) or peekToken()

Returns:

the coming token

Throws:

ScannerException - Thrown in case of malformed input.

IndexOutOfBoundsException - if no more token left

resetDocumentIndex

void resetDocumentIndex()