Class StringEscapeUtils
- java.lang.Object
- 
- groovy.json.StringEscapeUtils
 
- 
 public class StringEscapeUtils extends java.lang.ObjectEscapes and unescapesStrings 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 - Since:
- 2.0
 
- 
- 
Constructor SummaryConstructors Constructor Description StringEscapeUtils()StringEscapeUtilsinstances should NOT be constructed in standard programming.
 - 
Method SummaryAll Methods Static Methods Concrete Methods Modifier and Type Method Description static voidescapeJava(java.io.Writer out, java.lang.String str)Escapes the characters in aStringusing Java String rules to aWriter.static java.lang.StringescapeJava(java.lang.String str)Escapes the characters in aStringusing Java String rules.static voidescapeJavaScript(java.io.Writer out, java.lang.String str)Escapes the characters in aStringusing JavaScript String rules to aWriter.static java.lang.StringescapeJavaScript(java.lang.String str)Escapes the characters in aStringusing JavaScript String rules.static voidunescapeJava(java.io.Writer out, java.lang.String str)Unescapes any Java literals found in theStringto aWriter.static java.lang.StringunescapeJava(java.lang.String str)Unescapes any Java literals found in theString.static voidunescapeJavaScript(java.io.Writer out, java.lang.String str)Unescapes any JavaScript literals found in theStringto aWriter.static java.lang.StringunescapeJavaScript(java.lang.String str)Unescapes any JavaScript literals found in theString.
 
- 
- 
- 
Constructor Detail- 
StringEscapeUtilspublic StringEscapeUtils() StringEscapeUtilsinstances 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- 
escapeJavapublic static java.lang.String escapeJava(java.lang.String str) Escapes the characters in aStringusing 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: They didn't say, "Stop!" output string: They didn't say, \"Stop!\" - Parameters:
- str- String to escape values in, may be null
- Returns:
- String with escaped values, nullif null string input
 
 - 
escapeJavapublic static void escapeJava(java.io.Writer out, java.lang.String str) throws java.io.IOExceptionEscapes the characters in aStringusing Java String rules to aWriter.A nullstring input has no effect.- Parameters:
- out- Writer to write escaped string into
- str- String to escape values in, may be null
- Throws:
- java.lang.IllegalArgumentException- if the Writer is- null
- java.io.IOException- if error occurs on underlying Writer
- See Also:
- escapeJava(java.lang.String)
 
 - 
escapeJavaScriptpublic static java.lang.String escapeJavaScript(java.lang.String str) Escapes the characters in aStringusing 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: They didn't say, "Stop!" output string: They didn\'t say, \"Stop!\" - Parameters:
- str- String to escape values in, may be null
- Returns:
- String with escaped values, nullif null string input
 
 - 
escapeJavaScriptpublic static void escapeJavaScript(java.io.Writer out, java.lang.String str) throws java.io.IOExceptionEscapes the characters in aStringusing JavaScript String rules to aWriter.A nullstring input has no effect.- Parameters:
- out- Writer to write escaped string into
- str- String to escape values in, may be null
- Throws:
- java.lang.IllegalArgumentException- if the Writer is- null
- java.io.IOException- if error occurs on underlying Writer
- See Also:
- escapeJavaScript(java.lang.String)
 
 - 
unescapeJavapublic static java.lang.String unescapeJava(java.lang.String str) Unescapes any Java literals found in theString. For example, it will turn a sequence of'\'and'n'into a newline character, unless the'\'is preceded by another'\'.- Parameters:
- str- the- Stringto unescape, may be null
- Returns:
- a new unescaped String,nullif null string input
 
 - 
unescapeJavapublic static void unescapeJava(java.io.Writer out, java.lang.String str) throws java.io.IOExceptionUnescapes any Java literals found in the Stringto aWriter.For example, it will turn a sequence of '\'and'n'into a newline character, unless the'\'is preceded by another'\'.A nullstring input has no effect.- Parameters:
- out- the- Writerused to output unescaped characters
- str- the- Stringto unescape, may be null
- Throws:
- java.lang.IllegalArgumentException- if the Writer is- null
- java.io.IOException- if error occurs on underlying Writer
 
 - 
unescapeJavaScriptpublic static java.lang.String unescapeJavaScript(java.lang.String str) Unescapes any JavaScript literals found in theString.For example, it will turn a sequence of '\'and'n'into a newline character, unless the'\'is preceded by another'\'.- Parameters:
- str- the- Stringto unescape, may be null
- Returns:
- A new unescaped String,nullif null string input
- See Also:
- unescapeJava(String)
 
 - 
unescapeJavaScriptpublic static void unescapeJavaScript(java.io.Writer out, java.lang.String str) throws java.io.IOExceptionUnescapes any JavaScript literals found in theStringto aWriter.For example, it will turn a sequence of '\'and'n'into a newline character, unless the'\'is preceded by another'\'.A nullstring input has no effect.- Parameters:
- out- the- Writerused to output unescaped characters
- str- the- Stringto unescape, may be null
- Throws:
- java.lang.IllegalArgumentException- if the Writer is- null
- java.io.IOException- if error occurs on underlying Writer
- See Also:
- unescapeJava(Writer,String)
 
 
- 
 
-