Package com.g2forge.alexandria.java.text.escape

Interface IEscaper

All Known Implementing Classes:

AEscaper, SequenceEscaper, SingleCharacterEscaper

public interface IEscaper

Method Summary

Modifier and Type	Method	Description
void	computeEscape(String string, IConsumer1<? super TextUpdate<?>> consumer)
void	computeUnescape(String string, IConsumer1<? super TextUpdate<?>> consumer)
default String	escape(String string)	Escape some text.
Pattern	getRequiresEscapePattern()
default String	unescape(String string)	Unescape some text.

Method Detail

computeEscape

void computeEscape(String string,
                   IConsumer1<? super TextUpdate<?>> consumer)

computeUnescape

void computeUnescape(String string,
                     IConsumer1<? super TextUpdate<?>> consumer)

escape

default String escape(String string)

Escape some text.

Parameters:

string - The raw text to be escaped.

Returns:

The escaped text.

getRequiresEscapePattern

Pattern getRequiresEscapePattern()

unescape

default String unescape(String string)

Unescape some text.

Parameters:

string - The text to be unescaped.

Returns:

The raw text.