001/*-------------------------------------------------------------------------+
002|                                                                          |
003| Copyright 2005-2011 The ConQAT Project                                   |
004|                                                                          |
005| Licensed under the Apache License, Version 2.0 (the "License");          |
006| you may not use this file except in compliance with the License.         |
007| You may obtain a copy of the License at                                  |
008|                                                                          |
009|    http://www.apache.org/licenses/LICENSE-2.0                            |
010|                                                                          |
011| Unless required by applicable law or agreed to in writing, software      |
012| distributed under the License is distributed on an "AS IS" BASIS,        |
013| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
014| See the License for the specific language governing permissions and      |
015| limitations under the License.                                           |
016+-------------------------------------------------------------------------*/
017package eu.cqse.check.framework.scanner;
018
019import java.io.IOException;
020import java.io.Reader;
021
022/**
023 * Common interface for all scanners. Throws {@link ScannerException}s when
024 * unrecognized characters are encountered in the input.
025 * 
026 * @author Florian Deissenboeck
027 */
028public interface IScanner {
029
030        /**
031         * Returns the next token.
032         * 
033         * @return the next token. Returns {@link ETokenType#EOF} when current file
034         *         is entirely scanned.
035         * @throws ScannerException
036         *             Thrown upon scanner problems.
037         * @throws IOException
038         *             Thrown if the scanner encounters problem during file I/O.
039         */
040        public IToken getNextToken() throws IOException, ScannerException;
041
042        /**
043         * Reset the scanner.
044         * 
045         * @param reader
046         *            new input reader.
047         * @param originId
048         *            originId
049         */
050        public void reset(Reader reader, String originId);
051
052        /**
053         * Close scanner and any underlying readers.
054         * 
055         * @throws IOException
056         *             in case of an IO exception
057         */
058        public void close() throws IOException;
059}