Package org.shredzone.commons.text.filter

Class HtmlEscapeFilter

java.lang.Object

org.shredzone.commons.text.filter.HtmlEscapeFilter

All Implemented Interfaces:

Function<CharSequence,CharSequence>, TextFilter

public class HtmlEscapeFilter
extends Object
implements TextFilter

Escapes a plain text so it can be safely used in HTML. '<', '&' and '"' are replaced by their respective HTML entities.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor	Description
HtmlEscapeFilter()

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

HtmlEscapeFilter

public HtmlEscapeFilter()

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.