org.apache.karaf.util
Class StringEscapeUtils

java.lang.Object
  extended by org.apache.karaf.util.StringEscapeUtils

public class StringEscapeUtils
extends java.lang.Object

Util class to manipulate String, especially around escape/unescape.

Author:
gnodet, jbonofre

Constructor Summary
StringEscapeUtils()
           
 
Method Summary
static java.lang.String escapeJava(java.lang.String str)
          Escapes the characters in a String using Java String rules.
static java.lang.String hex(char ch)
          Returns an upper case hexadecimal String for the given character.
static java.lang.String unescapeJava(java.lang.String str)
          Unescapes any Java literals found in the String to a Writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringEscapeUtils

public StringEscapeUtils()
Method Detail

unescapeJava

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

Unescapes any Java literals found in the String to a Writer.

This is a slightly modified version of the StringEscapeUtils.unescapeJava() function in commons-lang that doesn't drop escaped separators (i.e '\,').

Parameters:
str - the String to unescape, may be null
Returns:
the processed string
Throws:
java.lang.IllegalArgumentException - if the Writer is null

escapeJava

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

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 must be escaped.

Example:

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

Parameters:
str - String to escape values in, may be null
Returns:
String with escaped values, null if null string input

hex

public static java.lang.String hex(char ch)

Returns an upper case hexadecimal String for the given character.

Parameters:
ch - The character to convert.
Returns:
An upper case hexadecimal String


Copyright © 2007-2011 Apache Software Foundation. All Rights Reserved.