net.grinder.util

Class SimpleStringEscaper

java.lang.Object

net.grinder.util.SimpleStringEscaper

All Implemented Interfaces:

StringEscaper

public class SimpleStringEscaper
extends Object
implements StringEscaper

Provides simple escaping and unescaping for 8-bit strings. The resulting string should survive translation between common line-ending conventions.

Escapes ASCII '\', '\n', '\r' by replacing them with literals "\\", "\\n", "\\r" respectively. Adds a new line ('\n') after replacing a '\n' so the resulting text is reasonably formatted. The unescape method strips all '\n' and '\r' in the input. Ignores platform line endings, that's only an issue for whatever does I/O with the results.

Class invariant: for all strings S, S=unescape(escape(S)). However, it is not true that for all Strings S, S=escape(unescape(S)) because unescape(S) strips {'\n', '\r'}.

Author:

Philip Aston

Constructor Summary

Constructors

Constructor and Description
SimpleStringEscaper()

Method Summary

Methods

Modifier and Type	Method and Description
String	escape(String unencoded) Escape a string.
String	unescape(String encoded) Unescape a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStringEscaper

public SimpleStringEscaper()

Method Detail

escape

public String escape(String unencoded)

Escape a string.

Specified by:

escape in interface StringEscaper

Parameters:

unencoded - The original string.

Returns:

The escaped string.

unescape

public String unescape(String encoded)

Unescape a string.

Specified by:

unescape in interface StringEscaper

Parameters:

encoded - The escaped string.

Returns:

The unescaped string.