|
Groovy 2.2.0 | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object groovy.json.StringEscapeUtils
public class StringEscapeUtils
Escapes and unescapes String
s for
Java, Java Script, HTML, XML, and SQL.
#ThreadSafe#
Note that this version is a stripped down version from Commons Lang 2.6 with only necessary methods for JSON builder
Constructor Summary | |
StringEscapeUtils()
|
Method Summary | |
---|---|
static String
|
escapeJava(String str)
Escapes the characters in a |
static void
|
escapeJava(Writer out, String str)
Escapes the characters in a |
static String
|
escapeJavaScript(String str)
Escapes the characters in a |
static void
|
escapeJavaScript(Writer out, String str)
Escapes the characters in a |
static String
|
unescapeJava(String str)
Unescapes any Java literals found in the |
static void
|
unescapeJava(Writer out, String str)
|
static String
|
unescapeJavaScript(String str)
Unescapes any JavaScript literals found in the |
static void
|
unescapeJavaScript(Writer out, String str)
|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Constructor Detail |
---|
public StringEscapeUtils()
StringEscapeUtils
instances should NOT be constructed in
standard programming.
Instead, the class should be used as:
StringEscapeUtils.escapeJava("foo");
This constructor is public to permit tools that require a JavaBean instance to operate.
Method Detail |
---|
public static String escapeJava(String str)
String
using Java String rules.
Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)
So a tab becomes the characters '\\'
and 't'
.
The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.
Example:
input string: He didn't say, "Stop!" output string: He didn't say, \"Stop!\"
str
- String to escape values in, may be nullnull
if null string input
public static void escapeJava(Writer out, String str)
String
using Java String rules to
a Writer
.
A null
string input has no effect.
null
out
- Writer to write escaped string intostr
- String to escape values in, may be null
public static String escapeJavaScript(String str)
String
using JavaScript String rules.
Escapes any values it finds into their JavaScript String form. Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)
So a tab becomes the characters '\\'
and 't'
.
The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.
Example:
input string: He didn't say, "Stop!" output string: He didn\'t say, \"Stop!\"
str
- String to escape values in, may be nullnull
if null string input
public static void escapeJavaScript(Writer out, String str)
String
using JavaScript String rules
to a Writer
.
A null
string input has no effect.
null
out
- Writer to write escaped string intostr
- String to escape values in, may be null
public static String unescapeJava(String str)
String
.
For example, it will turn a sequence of '\'
and
'n'
into a newline character, unless the '\'
is preceded by another '\'
.
str
- the String
to unescape, may be nullString
, null
if null string input
public static void unescapeJava(Writer out, String str)
Unescapes any Java literals found in the String
to a
Writer
.
For example, it will turn a sequence of '\'
and
'n'
into a newline character, unless the '\'
is preceded by another '\'
.
A null
string input has no effect.
null
out
- the Writer
used to output unescaped charactersstr
- the String
to unescape, may be null
public static String unescapeJavaScript(String str)
String
.
For example, it will turn a sequence of '\'
and 'n'
into a newline character, unless the '\'
is preceded by another
'\'
.
str
- the String
to unescape, may be nullString
, null
if null string input
public static void unescapeJavaScript(Writer out, String str)
Copyright © 2003-2013 The Codehaus. All rights reserved.