Package com.github.javaparser.utils

Class StringEscapeUtils

java.lang.Object

com.github.javaparser.utils.StringEscapeUtils

public final class StringEscapeUtils
extends java.lang.Object

Adapted from apache commons-lang3 project.

Unescapes escaped chars in strings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	StringEscapeUtils.AggregateTranslator	Adapted from apache commons-lang3 project.
private static class	StringEscapeUtils.CharSequenceTranslator	Adapted from apache commons-lang3 project.
private static class	StringEscapeUtils.LookupTranslator	Adapted from apache commons-lang3 project.
private static class	StringEscapeUtils.OctalUnescaper	Adapted from apache commons-lang3 project.
private static class	StringEscapeUtils.UnicodeUnescaper	Adapted from apache commons-lang3 project.

Field Summary

Fields

Modifier and Type	Field	Description
private static StringEscapeUtils.CharSequenceTranslator	ESCAPE_JAVA
private static StringEscapeUtils.LookupTranslator	JAVA_CTRL_CHARS_ESCAPE
private static StringEscapeUtils.LookupTranslator	JAVA_CTRL_CHARS_UNESCAPE
private static StringEscapeUtils.CharSequenceTranslator	UNESCAPE_JAVA
private static StringEscapeUtils.CharSequenceTranslator	UNESCAPE_JAVA_TEXT_BLOCK

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StringEscapeUtils()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	escapeJava(java.lang.String input)	Escapes the characters in a String using Java String rules.
static java.lang.String	unescapeJava(java.lang.String input)	Unescapes any Java literals found in the String.
static java.lang.String	unescapeJavaTextBlock(java.lang.String input)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_CTRL_CHARS_UNESCAPE

private static final StringEscapeUtils.LookupTranslator JAVA_CTRL_CHARS_UNESCAPE

JAVA_CTRL_CHARS_ESCAPE

private static final StringEscapeUtils.LookupTranslator JAVA_CTRL_CHARS_ESCAPE

ESCAPE_JAVA

private static final StringEscapeUtils.CharSequenceTranslator ESCAPE_JAVA

UNESCAPE_JAVA

private static final StringEscapeUtils.CharSequenceTranslator UNESCAPE_JAVA

UNESCAPE_JAVA_TEXT_BLOCK

private static final StringEscapeUtils.CharSequenceTranslator UNESCAPE_JAVA_TEXT_BLOCK

Constructor Detail

StringEscapeUtils

private StringEscapeUtils()

Method Detail

escapeJava

public static java.lang.String escapeJava(java.lang.String input)

Escapes the characters in a 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 and forward-slash (/) are escaped.

Example:

 input string: He didn't say, "Stop!"
 output string: He didn't say, \"Stop!\"
 

Parameters:

input - String to escape values in, may be null

Returns:

String with escaped values, null if null string input

unescapeJava

public static java.lang.String unescapeJava(java.lang.String input)

Unescapes any Java literals found in the String. For example, it will turn a sequence of '\' and 'n' into a newline character, unless the '\' is preceded by another '\'.

This can be replaced by String::translateEscapes in JDK 13

Parameters:

input - the String to unescape, may be null

Returns:

a new unescaped String, null if null string input

unescapeJavaTextBlock

public static java.lang.String unescapeJavaTextBlock(java.lang.String input)