Package org.shredzone.commons.text.filter

Class StripHtmlFilter

java.lang.Object

org.shredzone.commons.text.filter.StripHtmlFilter

All Implemented Interfaces:

Function<CharSequence,CharSequence>, TextFilter

public class StripHtmlFilter
extends Object
implements TextFilter

A filter that strips HTML markup from a text.

This filter distinguishes between block and inline tags. Block tags are replaced by a whitespace (unless there already was a whitespace before the tag), while inline tags are just removed.

Rationale: "foo<br>bar" is converted to "foo bar", while "foo<i>bar</i>" is converted to "foobar", similar to the way it is displayed in a web browser.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor	Description
StripHtmlFilter()

Method Summary

Modifier and Type	Method	Description
CharSequence	apply(CharSequence text)	Applies the filter on a CharSequence and returns a new CharSequence with the modified text.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.shredzone.commons.text.TextFilter

toStringBuilder

Constructor Details

StripHtmlFilter

public StripHtmlFilter()

Method Details

apply

public CharSequence apply(CharSequence text)

Description copied from interface: TextFilter

Applies the filter on a CharSequence and returns a new CharSequence with the modified text.

Specified by:

apply in interface Function<CharSequence,CharSequence>

Specified by:

apply in interface TextFilter

Parameters:

text - CharSequence with the contents to be filtered. If this is a StringBuilder instance, its contents may have changed after invocation, and this instance should not be used any more.

Returns:

CharSequence with the filtered text.