jp.sourceforge.livez.lang
クラス StringEscapeUtils

java.lang.Object
  上位を拡張 jp.sourceforge.livez.lang.StringEscapeUtils

public final class StringEscapeUtils
extends Object

Escapes and unescapes Strings for Java, Java Script, HTML, XML, and SQL.

導入されたバージョン:
2.0
バージョン:
$Id: StringEscapeUtils.java 165657 2005-05-02 18:31:49Z ggregory $
作成者:
Apache Jakarta Turbine, GenerationJavaCore library, Purple Technology, Henri Yandell, Alexander Day Chaffee, Antony Riley, Helge Tesgaard, Sean Brown, Gary Gregory, Phil Steitz, Pete Gieser

メソッドの概要
static String escapeHtml(String str)
          Escapes the characters in a String using HTML entities.
static String escapeJava(String str)
          Escapes the characters in a String using Java String rules.
static void escapeJava(Writer out, String str)
          Escapes the characters in a String using Java String rules to a Writer.
static String escapeJavaScript(String str)
          Escapes the characters in a String using JavaScript String rules.
static void escapeJavaScript(Writer out, String str)
          Escapes the characters in a String using JavaScript String rules to a Writer.
static String escapeXml(String str)
          Escapes the characters in a String using XML entities.
static String unescapeHtml(String str)
          Unescapes a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes.
static String unescapeJava(String str)
          Unescapes any Java literals found in the String.
static void unescapeJava(Writer out, String str)
          Unescapes any Java literals found in the String to a Writer.
static String unescapeJavaScript(String str)
          Unescapes any JavaScript literals found in the String.
static void unescapeJavaScript(Writer out, String str)
          Unescapes any JavaScript literals found in the String to a Writer.
static String unescapeXml(String str)
          Unescapes a string containing XML entity escapes to a string containing the actual Unicode characters corresponding to the escapes.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

escapeJava

public static String escapeJava(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!\"
 

パラメータ:
str - String to escape values in, may be null
戻り値:
String with escaped values, null if null string input

escapeJava

public static void escapeJava(Writer out,
                              String str)
                       throws IOException

Escapes the characters in a String using Java String rules to a Writer.

A null string input has no effect.

パラメータ:
out - Writer to write escaped string into
str - String to escape values in, may be null
例外:
IllegalArgumentException - if the Writer is null
IOException - if error occurs on underlying Writer
関連項目:
escapeJava(java.lang.String)

escapeJavaScript

public static String escapeJavaScript(String str)

Escapes the characters in a 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 null
戻り値:
String with escaped values, null if null string input

escapeJavaScript

public static void escapeJavaScript(Writer out,
                                    String str)
                             throws IOException

Escapes the characters in a String using JavaScript String rules to a Writer.

A null string input has no effect.

パラメータ:
out - Writer to write escaped string into
str - String to escape values in, may be null
例外:
IllegalArgumentException - if the Writer is null
IOException - if error occurs on underlying Writer
関連項目:
escapeJavaScript(java.lang.String)

unescapeJava

public static String unescapeJava(String str)

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 '\'.

パラメータ:
str - the String to unescape, may be null
戻り値:
a new unescaped String, null if null string input

unescapeJava

public static void unescapeJava(Writer out,
                                String str)
                         throws IOException

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.

パラメータ:
out - the Writer used to output unescaped characters
str - the String to unescape, may be null
例外:
IllegalArgumentException - if the Writer is null
IOException - if error occurs on underlying Writer

unescapeJavaScript

public static String unescapeJavaScript(String str)

Unescapes any JavaScript 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 '\'.

パラメータ:
str - the String to unescape, may be null
戻り値:
A new unescaped String, null if null string input
関連項目:
unescapeJava(String)

unescapeJavaScript

public static void unescapeJavaScript(Writer out,
                                      String str)
                               throws IOException

Unescapes any JavaScript 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.

パラメータ:
out - the Writer used to output unescaped characters
str - the String to unescape, may be null
例外:
IllegalArgumentException - if the Writer is null
IOException - if error occurs on underlying Writer
関連項目:
unescapeJava(Writer,String)

escapeHtml

public static String escapeHtml(String str)

Escapes the characters in a String using HTML entities.

For example:

"bread" & "butter"

becomes:

"bread" & "butter".

Supports all known HTML 4.0 entities, including funky accents.

パラメータ:
str - the String to escape, may be null
戻り値:
a new escaped String, null if null string input
関連項目:
unescapeHtml(String),
ISO Entities,
HTML 3.2 Character Entities for ISO Latin-1,
HTML 4.0 Character entity references,
HTML 4.01 Character References,
HTML 4.01 Code positions

unescapeHtml

public static String unescapeHtml(String str)

Unescapes a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes. Supports HTML 4.0 entities.

For example, the string "&lt;Fran&ccedil;ais&gt;" will become "<Français>"

If an entity is unrecognized, it is left alone, and inserted verbatim into the result string. e.g. "&gt;&zzzz;x" will become ">&zzzz;x".

パラメータ:
str - the String to unescape, may be null
戻り値:
a new unescaped String, null if null string input
関連項目:
escapeHtml(String)

escapeXml

public static String escapeXml(String str)

Escapes the characters in a String using XML entities.

For example: "bread" & "butter" => &quot;bread&quot; &amp; &quot;butter&quot;.

Supports only the five basic XML entities (gt, lt, quot, amp, apos). Does not support DTDs or external entities.

パラメータ:
str - the String to escape, may be null
戻り値:
a new escaped String, null if null string input
関連項目:
unescapeXml(java.lang.String)

unescapeXml

public static String unescapeXml(String str)

Unescapes a string containing XML entity escapes to a string containing the actual Unicode characters corresponding to the escapes.

Supports only the five basic XML entities (gt, lt, quot, amp, apos). Does not support DTDs or external entities.

パラメータ:
str - the String to unescape, may be null
戻り値:
a new unescaped String, null if null string input
関連項目:
escapeXml(String)


Copyright © 2005-2006 Kouji Sugisawa. All rights reserved.