Module io.jstach.jstachio

Package io.jstach.jstachio

Interface Escaper

All Superinterfaces:

Appender<Appendable>, Function<String,String>

public interface Escaper
extends Appender<Appendable>, Function<String,String>

An Escaper is an Appender used to escape content such as HTML. A Formatter is usually what will call the Escaper and like a formatter should be singleton like and expect reuse.

Author:

agentgt

See Also:

• JStacheContentType

Method Summary

Modifier and Type	Method	Description
default String	apply(String t)	Escapes a String by using StringBuilder and calling Appender.append(Appendable, CharSequence).
static Escaper	of(Function<String,String> escapeFunction)	Adapts a function to an Escaper.

Methods inherited from interface io.jstach.jstachio.Appender

append, append, append, append, append, append, append, append, toAppendable

Methods inherited from interface java.util.function.Function

andThen, compose

Method Details

apply

default String apply(String t)
              throws UncheckedIOException

Escapes a String by using StringBuilder and calling Appender.append(Appendable, CharSequence).

Specified by:

apply in interface Function<String,String>

Parameters:

t - String to ge escaped.

Returns:

escaped content

Throws:

UncheckedIOException - if the appender or appendable throw an IOException

of

static Escaper of(Function<String,String> escapeFunction)

Adapts a function to an Escaper. If the function is already an Escaper then it is simply returned (noop). Thus it is safe to repeatedly call this on Escaper. If the function is adapted the returned adapted Escaper does not pass native types to the inputted function.

Parameters:

escapeFunction - returned if it is already an escaper

Returns:

adapted Escaper