uk.co.strangeskies.text

Class EscapeFormatter

java.lang.Object

uk.co.strangeskies.text.EscapeFormatter

public class EscapeFormatter
extends java.lang.Object

Allow the escape of special characters in a character sequence by prefixture with a given special escape character.

Constructor Summary

Constructors

Constructor and Description
EscapeFormatter(char escapeCharacer, java.lang.String escapingCharacters) Create a new escaper with the given escape character and the escapable characters described by the given string.
EscapeFormatter(char escapeCharacer, java.lang.String escapingCharacters, java.util.Map<java.lang.String,java.lang.String> escapeTransforms) Create a new escaper with the given escape character and the escapable characters described by the given string.
EscapeFormatter(java.util.Map<java.lang.String,java.lang.String> escapeTransforms) Create a new escaper with the given escape character and the given escapable characters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	escape(java.lang.String string)
java.util.SortedMap<java.lang.String,java.lang.String>	getEscapedCharacters()
java.util.SortedMap<java.lang.String,java.lang.String>	getEscapingCharacters()
static EscapeFormatter	java()
java.lang.String	unescape(java.lang.String string)
static EscapeFormatter	xml()

Methods inherited from class java.lang.Object

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

Constructor Detail

EscapeFormatter

public EscapeFormatter(char escapeCharacer,
                       java.lang.String escapingCharacters)

Create a new escaper with the given escape character and the escapable characters described by the given string.

Parameters:

escapeCharacer - The character with which to escape the given escaping characters

escapingCharacters - The characters which should be escaped with the given escape character

EscapeFormatter

public EscapeFormatter(char escapeCharacer,
                       java.lang.String escapingCharacters,
                       java.util.Map<java.lang.String,java.lang.String> escapeTransforms)

Create a new escaper with the given escape character and the escapable characters described by the given string.

Parameters:

escapeCharacer - The character with which to escape the given escaping characters

escapingCharacters - The characters which should be escaped with the given escape character

escapeTransforms - Strings which should be escaped with the given escape character, mapped to the strings they represent.

EscapeFormatter

public EscapeFormatter(java.util.Map<java.lang.String,java.lang.String> escapeTransforms)

Create a new escaper with the given escape character and the given escapable characters.

Parameters:

escapeTransforms - Strings which should be escaped with the given escape character, mapped to the strings they represent.

Method Detail

java

public static EscapeFormatter java()

Returns:

A string escaper for java string literals.

xml

public static EscapeFormatter xml()

Returns:

A string escaper for java string literals.

getEscapingCharacters

public java.util.SortedMap<java.lang.String,java.lang.String> getEscapingCharacters()

Returns:

A mapping of escape characters to the character sequences they escape.

getEscapedCharacters

public java.util.SortedMap<java.lang.String,java.lang.String> getEscapedCharacters()

Returns:

A mapping of character sequences to their escaped characters.

escape

public java.lang.String escape(java.lang.String string)

Parameters:

string - The string we wish to escape

Returns:

The escaped form of the given string.

unescape

public java.lang.String unescape(java.lang.String string)

Parameters:

string - The string we wish to escape

Returns:

The escaped form of the given string.