Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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
`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.

Method Detail

### checkToken

    boolean checkToken(Token.ID... choices)

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

  Parameters:
    `choices` - token IDs.
  Returns:
    `true` if the next token can be assigned to a variable of at least one of the given types. 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.

### getToken

    Token getToken()

  Returns the next token.

  The token will be removed from the stream.

  Throws:
    `ScannerException` - Thrown in case of malformed input.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2011. All Rights Reserved.