org.yuanheng.cookjson

Class Quote

java.lang.Object

org.yuanheng.cookjson.Quote

public class Quote
extends Object

This class put a string in a double quote, escape characters as necessary.

See rfc4627 on quoted string:

         string = quotation-mark *char quotation-mark

         char = unescaped /
                escape (
                    %x22 /          ; "    quotation mark  U+0022
                    %x5C /          ; \    reverse solidus U+005C
                    %x2F /          ; /    solidus         U+002F
                    %x62 /          ; b    backspace       U+0008
                    %x66 /          ; f    form feed       U+000C
                    %x6E /          ; n    line feed       U+000A
                    %x72 /          ; r    carriage return U+000D
                    %x74 /          ; t    tab             U+0009
                    %x75 4HEXDIG )  ; uXXXX                U+XXXX

         escape = %x5C              ; \

         quotation-mark = %x22      ; "

         unescaped = %x20-21 / %x23-5B / %x5D-10FFFF
 

Author:

Heng Yuan

See Also:

rfc4627

Constructor Summary

Constructors

Constructor and Description
Quote()

Method Summary

Modifier and Type	Method and Description
static String	quote(String str) This function double quotes a string and escapes characters as necessary so that the generated string can be used either as the key name or raw string value.
static void	quote(Writer out, String str) Quote a string

Methods inherited from class java.lang.Object

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

Constructor Detail

Quote

public Quote()

Method Detail

quote

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

Quote a string

Parameters:

out - writer

str - string to be quoted and written

Throws:

IOException - in case of I/O error.

quote

public static String quote(String str)

This function double quotes a string and escapes characters as necessary so that the generated string can be used either as the key name or raw string value.

The main use case of this function is to generate double quoted key names. This way, by setting TextJsonGenerator.setKeyNameEscaped(boolean) to true, user can improve the JSON output performance in applications where the same key names are being used over and over again (such as database ResultSet).

Parameters:

str - the string to be double quoted.

Returns:

The double quoted string.