All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.snakeyaml.engine.v2.scanner.Scanner Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 2018, SnakeYAML
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package org.snakeyaml.engine.v2.scanner;


import java.util.Iterator;
import org.snakeyaml.engine.v2.exceptions.ScannerException;
import org.snakeyaml.engine.v2.tokens.Token;

/**
 * This interface represents an input stream of {@link Token}s.
 * 

* The scanner and the parser form together the 'Parse' step in the loading process. *

* * @see 3.1. Processes */ public interface Scanner extends Iterator { /** * Check if the next token is one of the given types. * * @param choices token IDs to match with * @return 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. */ boolean checkToken(Token.ID... choices); /** * Check if the next token is the given type. * * @param choice token ID to match with * @return 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. */ default boolean checkToken(Token.ID choice) { return checkToken(new Token.ID[] {choice}); } /** * Return the next token, but do not delete it from the stream. * * @return The token that will be returned on the next call to {@link #next} * @throws ScannerException Thrown in case of malformed input. * @throws IndexOutOfBoundsException if no more token left */ Token peekToken(); /** * Returns the next token. *

* The token will be removed from the stream. (Every invocation of this method must happen after * calling either {@link #checkToken} or {@link #peekToken()} *

* * @return the coming token * @throws ScannerException Thrown in case of malformed input. * @throws IndexOutOfBoundsException if no more token left */ Token next(); /** * Set the document index to 0 after a document end */ void resetDocumentIndex(); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy