Package org.yaml.snakeyaml.scanner
Interface Scanner
-
- All Known Implementing Classes:
ScannerImpl
public interface ScannerThis interface represents an input stream ofTokens.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancheckToken(Token.ID... choices)Check if the next token is one of the given types.TokengetToken()Returns the next token.TokenpeekToken()Return the next token, but do not delete it from the stream.
-
-
-
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:
trueif the next token is one of the given types. Returnsfalseif 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...)orpeekToken()- Returns:
- the coming token
- Throws:
ScannerException- Thrown in case of malformed input.IndexOutOfBoundsException- if no more token left
-
-