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

Class AEscaper

java.lang.Object

com.g2forge.alexandria.java.text.escape.AEscaper

All Implemented Interfaces:

IEscaper

Direct Known Subclasses:

SequenceEscaper, SingleCharacterEscaper

public abstract class AEscaper
extends Object
implements IEscaper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AEscaper.Change

Field Summary

Fields

Modifier and Type	Field	Description
protected String	postfix
protected String	prefix

Constructor Summary

Constructors

Constructor	Description
AEscaper(String prefix, String postfix)	Create an escaper.

Method Summary

Modifier and Type	Method	Description
protected abstract AEscaper.Change	computeEscape(String string, int index)
void	computeEscape(String string, IConsumer1<? super TextUpdate<?>> consumer)
protected abstract Pattern	computeRequiresEscapePattern()
protected abstract AEscaper.Change	computeUnescape(String string, int index)
void	computeUnescape(String string, IConsumer1<? super TextUpdate<?>> consumer)
protected String	getPostfix()
protected String	getPrefix()
Pattern	getRequiresEscapePattern()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.g2forge.alexandria.java.text.escape.IEscaper

escape, unescape

Field Detail

prefix

protected final String prefix

postfix

protected final String postfix

Constructor Detail

AEscaper

public AEscaper(String prefix,
                String postfix)

Create an escaper.

Parameters:

prefix - A string which prefixes all escape sequences.

postfix - A string which postfixes all escape sequences.

Method Detail

computeEscape

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

Specified by:

computeEscape in interface IEscaper

computeEscape

protected abstract AEscaper.Change computeEscape(String string,
                                                 int index)

computeRequiresEscapePattern

protected abstract Pattern computeRequiresEscapePattern()

computeUnescape

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

Specified by:

computeUnescape in interface IEscaper

computeUnescape

protected abstract AEscaper.Change computeUnescape(String string,
                                                   int index)

getPrefix

protected String getPrefix()

getPostfix

protected String getPostfix()

getRequiresEscapePattern

public Pattern getRequiresEscapePattern()

Specified by:

getRequiresEscapePattern in interface IEscaper