Class BufferedCharFilter

LUCENENET specific class to mimic Java's BufferedReader (that is, a reader that is seekable) so it supports Mark() and Reset() (which are part of the Java Reader class), but also provide the Correct() method of BaseCharFilter.

Inheritance
System.Object
System.MarshalByRefObject
System.IO.TextReader
CharFilter
BaseCharFilter
BufferedCharFilter
Inherited Members
System.IO.TextReader.Null
System.IO.TextReader.Dispose()
System.IO.TextReader.ReadLineAsync()
System.IO.TextReader.ReadToEndAsync()
System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)
System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)
System.IO.TextReader.Synchronized(System.IO.TextReader)
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.CreateObjRef(System.Type)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
[Serializable]
public class BufferedCharFilter : BaseCharFilter, IDisposable

Constructors

Name Description
BufferedCharFilter(TextReader)

Creates a buffering character-input stream that uses a default-sized input buffer.
BufferedCharFilter(TextReader, Int32)

Creates a buffering character-input stream that uses an input buffer of the specified size.

Fields

Name Description
DEFAULT_CHAR_BUFFER_SIZE
m_lock

The object used to synchronize access to the reader.

Properties

Name Description
IsMarkSupported

Indicates whether this reader supports the Mark(Int32) and Reset() methods. This implementation returns true.
IsReady

Indicates whether this reader is ready to be read without blocking.

Methods

Name Description
Close()
Dispose(Boolean)

Disposes this reader. This implementation closes the buffered source reader and releases the buffer. Nothing is done if this reader has already been disposed.
InitializeLifetimeService()
Mark(Int32)

Sets a mark position in this reader. The parameter markLimit indicates how many characters can be read before the mark is invalidated. Calling Reset() will reposition the reader back to the marked position if Lucene.Net.Analysis.Util.BufferedCharFilter.markLimit has not been surpassed.
Peek()
Read()

Reads a single character from this reader and returns it with the two higher-order bytes set to 0. If possible, BufferedCharFilter returns a character from the buffer. If there are no characters available in the buffer, it fills the buffer and then returns a character. It returns -1 if there are no more characters in the source reader.
Read(Char[], Int32, Int32)

Reads at most length characters from this reader and stores them at offset in the character array buffer. Returns the number of characters actually read or -1 if the end of the source reader has been reached. If all the buffered characters have been used, a mark has not been set and the requested number of characters is larger than this readers buffer size, BufferedReader bypasses the buffer and simply places the results directly into buffer.
ReadBlock(Char[], Int32, Int32)
ReadLine()

Returns the next line of text available from this reader. A line is represented by zero or more characters followed by '\n', '\r', "\r\n" or the end of the reader. The string does not include the newline sequence.
ReadToEnd()
Reset()

Resets this reader's position to the last Mark(Int32) location. Invocations of Read() and Skip(Int32) will occur from this new location.
Skip(Int32)

Skips amount characters in this reader. Subsequent Read()s will not return these characters unless Reset() is used. Skipping characters may invalidate a mark if Lucene.Net.Analysis.Util.BufferedCharFilter.markLimit is surpassed.

Extension Methods