/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.cassandra.index.sasi.analyzer;

import java.io.IOException;
import java.io.Reader;

Internal interface for supporting versioned grammars.
/**
 * Internal interface for supporting versioned grammars.
 */
public interface StandardTokenizerInterface
{

    String getText();

    char[] getArray();

    byte[] getBytes();

    
Returns the current position.
/**
     * Returns the current position.
     */
    int yychar();

    
Returns the length of the matched text region.
/**
     * Returns the length of the matched text region.
     */
    int yylength();

    
Resumes scanning until the next regular expression is matched,
the end of input is encountered or an I/O-Error occurs.
Throws:
IOException –  if any I/O-Error occurs
Returns:
 the next token, YYEOF on end of stream/**
     * Resumes scanning until the next regular expression is matched,
     * the end of input is encountered or an I/O-Error occurs.
     *
     * @return      the next token, {@link #YYEOF} on end of stream
     * @exception   java.io.IOException  if any I/O-Error occurs
     */
    int getNextToken() throws IOException;

    
Resets the scanner to read from a new input stream.
Does not close the old reader.
All internal variables are reset, the old input stream
cannot be reused (internal buffer is discarded and lost).
Lexical state is set to ZZ_INITIAL.
Params:
reader –   the new input stream/**
     * Resets the scanner to read from a new input stream.
     * Does not close the old reader.
     *
     * All internal variables are reset, the old input stream
     * <b>cannot</b> be reused (internal buffer is discarded and lost).
     * Lexical state is set to <tt>ZZ_INITIAL</tt>.
     *
     * @param reader   the new input stream
     */
    void yyreset(Reader reader);
}