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

Lucene.Net.Analysis.CharFilter

BaseCharFilter

BufferedCharFilter

Implements

System.IDisposable

Inherited Members

BaseCharFilter.Correct(Int32)

BaseCharFilter.LastCumulativeDiff

BaseCharFilter.AddOffCorrectMap(Int32, Int32)

Lucene.Net.Analysis.CharFilter.m_input

CharFilter.CorrectOffset(Int32)

System.IO.TextReader.Null

System.IO.TextReader.Dispose()

System.IO.TextReader.Synchronized(System.IO.TextReader)

System.MarshalByRefObject.GetLifetimeService()

System.MarshalByRefObject.MemberwiseClone(System.Boolean)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Analysis.Util

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public class BufferedCharFilter : BaseCharFilter, IDisposable

Constructors

BufferedCharFilter(TextReader)

Creates a buffering character-input stream that uses a default-sized input buffer.

Declaration

public BufferedCharFilter(TextReader in)

Parameters

Type	Name	Description
System.IO.TextReader	in	A TextReader

BufferedCharFilter(TextReader, Int32)

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

Declaration

public BufferedCharFilter(TextReader in, int size)

Parameters

Type	Name	Description
System.IO.TextReader	in	A TextReader
System.Int32	size	Input-buffer size

Fields

DEFAULT_CHAR_BUFFER_SIZE

Declaration

public const int DEFAULT_CHAR_BUFFER_SIZE = 8192

Field Value

Type	Description
System.Int32

m_lock

The object used to synchronize access to the reader.

Declaration

protected object m_lock

Field Value

Type	Description
System.Object

Properties

IsMarkSupported

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

Declaration

public override bool IsMarkSupported { get; }

Property Value

Type	Description
System.Boolean

Overrides

Lucene.Net.Analysis.CharFilter.IsMarkSupported

See Also

Mark(Int32)

Reset()

IsReady

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

Declaration

public override bool IsReady { get; }

Property Value

Type	Description
System.Boolean	true if this reader will not block when Read() is called, false if unknown or blocking will occur.

Overrides

Lucene.Net.Analysis.CharFilter.IsReady

Methods

Close()

Declaration

public override void Close()

Overrides

System.IO.TextReader.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.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Overrides

CharFilter.Dispose(Boolean)

Exceptions

Type	Condition
System.IO.IOException	if an error occurs while closing this reader.

InitializeLifetimeService()

Declaration

public override object InitializeLifetimeService()

Returns

Type	Description
System.Object

Overrides

System.MarshalByRefObject.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.

Declaration

public override void Mark(int markLimit)

Parameters

Type	Name	Description
System.Int32	markLimit	the number of characters that can be read before the mark is invalidated.

Overrides

CharFilter.Mark(Int32)

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	if markLimit < 0
System.IO.IOException	if an error occurs while setting a mark in this reader.

Peek()

Declaration

public override int Peek()

Returns

Type	Description
System.Int32

Overrides

System.IO.TextReader.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.

Declaration

public override int Read()

Returns

Type	Description
System.Int32	The character read or -1 if the end of the source reader has been reached.

Overrides

Lucene.Net.Analysis.CharFilter.Read()

Exceptions

Type	Condition
System.IO.IOException	If this reader is disposed or some other I/O error occurs.

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.

Declaration

public override int Read(char[] buffer, int offset, int length)

Parameters

Type	Name	Description
System.Char[]	buffer	the character array to store the characters read.
System.Int32	offset	the initial position in buffer to store the bytes read from this reader.
System.Int32	length	the maximum number of characters to read, must be non-negative.

Returns

Type	Description
System.Int32	number of characters read or -1 if the end of the source reader has been reached.

Overrides

CharFilter.Read(Char[], Int32, Int32)

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	if offset < 0 or length < 0, or if offset + length is greater than the size of buffer.
System.IO.IOException	if this reader is disposed or some other I/O error occurs.

ReadAsync(Char[], Int32, Int32)

Declaration

public override Task<int> ReadAsync(char[] buffer, int index, int count)

Parameters

Type	Name	Description
System.Char[]	buffer
System.Int32	index
System.Int32	count

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

Overrides

System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)

ReadBlock(Char[], Int32, Int32)

Declaration

public override int ReadBlock(char[] buffer, int index, int count)

Parameters

Type	Name	Description
System.Char[]	buffer
System.Int32	index
System.Int32	count

Returns

Type	Description
System.Int32

Overrides

System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)

ReadBlockAsync(Char[], Int32, Int32)

Declaration

public override Task<int> ReadBlockAsync(char[] buffer, int index, int count)

Parameters

Type	Name	Description
System.Char[]	buffer
System.Int32	index
System.Int32	count

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

Overrides

System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.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.

Declaration

public override string ReadLine()

Returns

Type	Description
System.String	The contents of the line or null if no characters were read before the end of the reader has been reached.

Overrides

System.IO.TextReader.ReadLine()

Exceptions

Type	Condition
System.IO.IOException	if this reader is disposed or some other I/O error occurs.

ReadLineAsync()

Declaration

public override Task<string> ReadLineAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

Overrides

System.IO.TextReader.ReadLineAsync()

ReadToEnd()

Declaration

public override string ReadToEnd()

Returns

Type	Description
System.String

Overrides

System.IO.TextReader.ReadToEnd()

ReadToEndAsync()

Declaration

public override Task<string> ReadToEndAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

Overrides

System.IO.TextReader.ReadToEndAsync()

Reset()

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

Declaration

public override void Reset()

Overrides

Lucene.Net.Analysis.CharFilter.Reset()

Exceptions

Type	Condition
System.IO.IOException	If this reader is disposed or no mark has been set.

See Also

Mark(Int32)

IsMarkSupported

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.

Declaration

public override long Skip(int amount)

Parameters

Type	Name	Description
System.Int32	amount	the maximum number of characters to skip.

Returns

Type	Description
System.Int64	the number of characters actually skipped.

Overrides

CharFilter.Skip(Int32)

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	if amount < 0.
System.IO.IOException	If this reader is disposed or some other I/O error occurs.

See Also

Mark(Int32)

IsMarkSupported

Reset()

Implements

System.IDisposable