queryparser/org.gnit.lucenekmp.queryparser.charstream/FastCharStream

FastCharStream

class FastCharStream(r: Reader) : CharStream

An efficient implementation of JavaCC's CharStream interface.

Note that this does not do line-number counting, but instead keeps track of the character position of the token in the input, as required by Lucene's [ ] API.

Constructors

FastCharStream

constructor(r: Reader)

Types

Companion

object Companion

Properties

beginColumn

open override val beginColumn: Int

Returns the column number of the first character for current token (being matched after the last call to BeginTOken).

beginLine

open override val beginLine: Int

Returns the line number of the first character for current token (being matched after the last call to BeginTOken).

buffer

var buffer: CharArray?

bufferLength

var bufferLength: Int

bufferPosition

var bufferPosition: Int

bufferStart

var bufferStart: Int

endColumn

open override val endColumn: Int

Returns the column number of the last character for current token (being matched after the last call to BeginTOken).

endLine

open override val endLine: Int

Returns the line number of the last character for current token (being matched after the last call to BeginTOken).

input

var input: Reader

tokenStart

var tokenStart: Int

Functions

backup

open override fun backup(amount: Int)

Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implementation's responsibility to do this right.

BeginToken

open override fun BeginToken(): Char

Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly.

Done

open override fun Done()

The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class. Again, the body of this function can be just empty and it will not affect the lexer's operation.

GetImage

open override fun GetImage(): String

Returns a string made up of characters from the marked token beginning to the current buffer position. Implementations have the choice of returning anything that they want to. For example, for efficiency, one might decide to just return null, which is a valid implementation.

GetSuffix

open override fun GetSuffix(len: Int): CharArray

Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows :

readChar

open override fun readChar(): Char

Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this interface. Can throw any java.io.IOException.