Package org.apache.lucene.analysis.charfilter

Class HTMLStripCharFilter

java.lang.Object

java.io.Reader

org.apache.lucene.analysis.CharFilter

org.apache.lucene.analysis.charfilter.BaseCharFilter

org.apache.lucene.analysis.charfilter.HTMLStripCharFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class HTMLStripCharFilter
extends BaseCharFilter

A CharFilter that wraps another Reader and attempts to strip out HTML constructs.

Constructor Summary

Constructors

Constructor	Description
HTMLStripCharFilter(Reader source)	Creates a new HTMLStripCharFilter over the provided Reader.
HTMLStripCharFilter(Reader source, Set<String> escapedTags)	Creates a new HTMLStripCharFilter over the provided Reader with the specified start and end tags.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying input stream.
int	read()
int	read(char[] cbuf, int off, int len)

Methods inherited from class org.apache.lucene.analysis.CharFilter

correctOffset

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, ready, reset, skip, transferTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HTMLStripCharFilter

public HTMLStripCharFilter(Reader source)

Creates a new HTMLStripCharFilter over the provided Reader.

Parameters:

source - Reader to strip html tags from.

HTMLStripCharFilter

public HTMLStripCharFilter(Reader source,
 Set<String> escapedTags)

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

Parameters:

source - Reader to strip html tags from.

escapedTags - Tags in this set (both start and end tags) will not be filtered out.

Method Details

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
 int off,
 int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: CharFilter

Closes the underlying input stream.

NOTE: The default implementation closes the input Reader, so be sure to call super.close() when overriding this method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class CharFilter

Throws:

IOException