Package org.shredzone.commons.text

Interface TextFilter

All Superinterfaces:

Function<CharSequence,CharSequence>

All Known Implementing Classes:

GithubFlavoredMarkdownFilter, HtmlEscapeFilter, KeepFilter, LinkToUrlFilter, MarkdownFilter, NofollowLinksFilter, NormalizeFilter, ParagraphFilter, SimplifyHtmlFilter, SmilyFilter, StripHtmlFilter, TextileFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface TextFilter
extends Function<CharSequence,CharSequence>

A text filter modifies a text in a defined manner. It should be highly optimized for speed.

Text filters are thread safe unless stated otherwise.

Text filters are stateless unless stated otherwise.

Author:

Richard "Shred" Körber

Method Summary

Modifier and Type	Method	Description
CharSequence	apply(CharSequence t)	Applies the filter on a CharSequence and returns a new CharSequence with the modified text.
default StringBuilder	toStringBuilder(CharSequence text)	Returns a StringBuilder for the given CharSequence.

Methods inherited from interface java.util.function.Function

andThen, compose

Method Details

apply

CharSequence apply(CharSequence t)

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

Specified by:

apply in interface Function<CharSequence,CharSequence>

Parameters:

t - 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.

toStringBuilder

default StringBuilder toStringBuilder(CharSequence text)

Returns a StringBuilder for the given CharSequence. If the CharSequence is a StringBuilder instance, it will be reused.

Parameters:

text - CharSequence to get a StringBuilder from

Returns:

StringBuilder instance