io.jstuff.json

Class JSONFunctions

java.lang.Object

io.jstuff.json.JSONFunctions

public class JSONFunctions
extends Object

A set of static functions used in conversion to and from JSON string representations.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static String	ILLEGAL_CHAR
static String	ILLEGAL_ESCAPE_SEQUENCE
static String	ILLEGAL_UNICODE_SEQUENCE
static String	UNTERMINATED_STRING

Constructor Summary

Constructors

Constructor and Description
JSONFunctions()

Method Summary

Modifier and Type	Method and Description
static void	appendChar(Appendable a, char ch, boolean includeNonASCII) Append a single character to an Appendable applying JSON escaping rules.
static void	appendDisplayString(Appendable a, String str, int maxChars) Append a display form of a string to an Appendable, usually for error reporting.
static void	appendString(Appendable a, CharSequence cs, boolean includeNonASCII) Append a CharSequence to an Appendable in JSON quoted string form (applying JSON escaping rules).
static String	displayString(String str, int maxChars) Create a display form of a string, usually for error reporting.
static String	escapeString(CharSequence cs, boolean includeNonASCII) Convert a CharSequence to a String in JSON quoted string form (applying JSON escaping rules).
static String	escapeStringUnquoted(CharSequence cs) Convert a CharSequence to a String, applying JSON escaping rules without enclosing quotes.
static String	escapeStringUnquoted(CharSequence cs, boolean includeNonASCII) Convert a CharSequence to a String, applying JSON escaping rules without enclosing quotes.
static boolean	isSpaceCharacter(char ch) Test whether a given character is a space, according to the JSON specification.
static void	outputChar(char ch, boolean includeNonASCII, IntConsumer consumer) Output a single character using an IntConsumer applying JSON escaping rules.
static void	outputString(CharSequence cs, boolean includeNonASCII, IntConsumer consumer) Output a CharSequence using an IntConsumer in JSON quoted string form (applying JSON escaping rules).
static String	parseString(io.jstuff.text.TextMatcher tm) Parse a JSON string from the current position of a TextMatcher (which must be positioned after the opening double quote).

Methods inherited from class java.lang.Object

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

Field Detail

UNTERMINATED_STRING

public static final String UNTERMINATED_STRING

See Also:

Constant Field Values

ILLEGAL_CHAR

public static final String ILLEGAL_CHAR

See Also:

Constant Field Values

ILLEGAL_UNICODE_SEQUENCE

public static final String ILLEGAL_UNICODE_SEQUENCE

See Also:

Constant Field Values

ILLEGAL_ESCAPE_SEQUENCE

public static final String ILLEGAL_ESCAPE_SEQUENCE

See Also:

Constant Field Values

Constructor Detail

JSONFunctions

public JSONFunctions()

Method Detail

appendString

public static void appendString(Appendable a,
                                CharSequence cs,
                                boolean includeNonASCII)
                         throws IOException

Append a CharSequence to an Appendable in JSON quoted string form (applying JSON escaping rules). The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true.

Parameters:

a - the Appendable

cs - the CharSequence

includeNonASCII - if true, output the characters above the ASCII range without escaping

Throws:

IOException - if thrown by the Appendable

outputString

public static void outputString(CharSequence cs,
                                boolean includeNonASCII,
                                IntConsumer consumer)

Output a CharSequence using an IntConsumer in JSON quoted string form (applying JSON escaping rules). The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true.

Parameters:

cs - the CharSequence

includeNonASCII - if true, output the characters above the ASCII range without escaping

consumer - the IntConsumer

escapeString

public static String escapeString(CharSequence cs,
                                  boolean includeNonASCII)

Convert a CharSequence to a String in JSON quoted string form (applying JSON escaping rules). The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true.

Parameters:

cs - the CharSequence

includeNonASCII - if true, output the characters above the ASCII range without escaping

Returns:

the converted string

escapeStringUnquoted

public static String escapeStringUnquoted(CharSequence cs,
                                          boolean includeNonASCII)

Convert a CharSequence to a String, applying JSON escaping rules without enclosing quotes. The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true. If there are no characters requiring conversion, the original string is returned unmodified.

Parameters:

cs - the CharSequence

includeNonASCII - if true, output the characters above the ASCII range without escaping

Returns:

the converted string

escapeStringUnquoted

public static String escapeStringUnquoted(CharSequence cs)

Convert a CharSequence to a String, applying JSON escaping rules without enclosing quotes. If there are no characters requiring conversion, the original string is returned unmodified.

Parameters:

cs - the CharSequence

Returns:

the converted string

appendChar

public static void appendChar(Appendable a,
                              char ch,
                              boolean includeNonASCII)
                       throws IOException

Append a single character to an Appendable applying JSON escaping rules. The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true.

Parameters:

a - the Appendable

ch - the character

includeNonASCII - if true, output the characters above the ASCII range without escaping

Throws:

IOException - if thrown by the Appendable

outputChar

public static void outputChar(char ch,
                              boolean includeNonASCII,
                              IntConsumer consumer)

Output a single character using an IntConsumer applying JSON escaping rules. The characters above the ASCII range (0x20 to 0x7E) are output as Unicode escape sequences unless the includeNonASCII flag is set to true.

Parameters:

ch - the character

includeNonASCII - if true, output the characters above the ASCII range without escaping

consumer - the IntConsumer

displayString

public static String displayString(String str,
                                   int maxChars)

Create a display form of a string, usually for error reporting. The string is constrained to a maximum number of characters, and if it exceeds that number the string is split and " ... " is inserted in the middle (because the inserted string is 5 characters long, the elided string will look better if an odd number is chosen for the maximum length, since that will result in equal length substrings at start and end).

Parameters:

str - the string

maxChars - the maximum number of characters (ignored if < 8)

Returns:

the display string

appendDisplayString

public static void appendDisplayString(Appendable a,
                                       String str,
                                       int maxChars)
                                throws IOException

Append a display form of a string to an Appendable, usually for error reporting. The string is constrained to a maximum number of characters, and if it exceeds that number the string is split and " ... " is inserted in the middle (because the inserted string is 5 characters long, the elided string will look better if an odd number is chosen for the maximum length, since that will result in equal length substrings at start and end).

Parameters:

a - the Appendable

str - the string

maxChars - the maximum number of characters (ignored if < 8)

Throws:

IOException

parseString

public static String parseString(io.jstuff.text.TextMatcher tm)

Parse a JSON string from the current position of a TextMatcher (which must be positioned after the opening double quote). The index is left positioned after the closing double quote.

Parameters:

tm - a TextMatcher

Returns:

the JSON string

Throws:

IllegalArgumentException - if there are any errors in the JSON

isSpaceCharacter

public static boolean isSpaceCharacter(char ch)

Test whether a given character is a space, according to the JSON specification.

Parameters:

ch - the character

Returns:

true if the character is a space