Class HTMLStripCharFilter

A Lucene.Net.Analysis.CharFilter that wraps another TextReader and attempts to strip out HTML constructs.

Inheritance

object

MarshalByRefObject

TextReader

CharFilter

BaseCharFilter

HTMLStripCharFilter

Implements

IDisposable

Inherited Members

CharFilter.CorrectOffset(int)

CharFilter.Skip(int)

CharFilter.Reset()

CharFilter.IsReady

CharFilter.IsMarkSupported

CharFilter.Mark(int)

TextReader.Null

TextReader.Close()

TextReader.Dispose()

TextReader.Peek()

TextReader.Read(Span<char>)

TextReader.ReadAsync(char[], int, int)

TextReader.ReadAsync(Memory<char>, CancellationToken)

TextReader.ReadBlock(char[], int, int)

TextReader.ReadBlock(Span<char>)

TextReader.ReadBlockAsync(char[], int, int)

TextReader.ReadBlockAsync(Memory<char>, CancellationToken)

TextReader.ReadLine()

TextReader.ReadLineAsync()

TextReader.ReadLineAsync(CancellationToken)

TextReader.ReadToEnd()

TextReader.ReadToEndAsync()

TextReader.ReadToEndAsync(CancellationToken)

TextReader.Synchronized(TextReader)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Analysis.CharFilters

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public sealed class HTMLStripCharFilter : BaseCharFilter, IDisposable

Constructors

HTMLStripCharFilter(TextReader)

Creates a new HTMLStripCharFilter over the provided TextReader.

Declaration

public HTMLStripCharFilter(TextReader source)

Parameters

Type	Name	Description
TextReader	source	TextReader to strip html tags from.

HTMLStripCharFilter(TextReader, ICollection<string>)

Creates a new HTMLStripCharFilter over the provided TextReader with the specified start and end tags.

Declaration

public HTMLStripCharFilter(TextReader source, ICollection<string> escapedTags)

Parameters

Type	Name	Description
TextReader	source	TextReader to strip html tags from.
ICollection<string>	escapedTags	Tags in this set (both start and end tags) will not be filtered out.

Methods

Dispose(bool)

Closes the underlying input stream.

NOTE: The default implementation closes the input TextReader, so be sure to call base.Dispose(disposing) when overriding this method.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

CharFilter.Dispose(bool)

Read()

Reads the next character from the text reader and advances the character position by one character.

Declaration

public override int Read()

Returns

Type	Description
int	The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.

Overrides

Lucene.Net.Analysis.CharFilter.Read()

Exceptions

Type	Condition
ObjectDisposedException	The TextReader is closed.
IOException	An I/O error occurs.

Read(char[], int, int)

Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

Declaration

public override int Read(char[] cbuf, int off, int len)

Parameters

Type	Name	Description
char[]	cbuf
int	off
int	len

Returns

Type	Description
int	The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

Overrides

CharFilter.Read(char[], int, int)

Exceptions

Type	Condition
ArgumentNullException	buffer is null.
ArgumentException	The buffer length minus index is less than count.
ArgumentOutOfRangeException	index or count is negative.
ObjectDisposedException	The TextReader is closed.
IOException	An I/O error occurs.

Implements

IDisposable