org.bspfsystems.simplejson.parser

Class JSONParser

java.lang.Object

org.bspfsystems.simplejson.parser.JSONParser

public final class JSONParser
extends Object

Provides JSON utilities for serializing and deserializing various objects.

Method Summary

Modifier and Type	Method and Description
static @NotNull Object	deserialize(@NotNull Reader reader) Deserializes the data in the given Reader into an Object.
static @NotNull Object	deserialize(@NotNull String data) Deserializes the given String data into an Object.
static @Nullable JSONArray	deserializeArray(@NotNull Reader reader) Deserializes the data in the given Reader into a JSONArray.
static @Nullable JSONArray	deserializeArray(@NotNull String data) Deserializes the given String data into a JSONArray.
static @Nullable JSONObject	deserializeObject(@NotNull Reader reader) Deserializes the data in the given Reader into a JSONObject.
static @Nullable JSONObject	deserializeObject(@NotNull String data) Deserializes the given String data into a JSONObject.
static @NotNull String	format(@NotNull Reader reader) Formats the JSON data in the given Reader into a human-readable format using indentation and newlines.
static @NotNull String	format(@NotNull Reader reader, @NotNull String indent, @NotNull String newline) Formats the gSON data in the given Reader into a human-readable format using indentation and newlines, both of the caller's choice.
static @NotNull String	format(@NotNull String data) Formats the given String JSON data into a human-readable format using indentation and newlines.
static @NotNull String	format(@NotNull String data, @NotNull String indent, @NotNull String newline) Formats the given String JSON data into a human-readable format using indentation and newlines, both of the caller's choice.
static @NotNull String	serialize(@Nullable Object data) Serializes the given Object into String data.

Methods inherited from class java.lang.Object

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

Method Detail

deserialize

@NotNull
public static @NotNull Object deserialize(@NotNull
                                                   @NotNull String data)
                                            throws JSONException

Deserializes the given String data into an Object.

Parameters:

data - The JSON data in String format.

Returns:

An Object containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

deserialize

@NotNull
public static @NotNull Object deserialize(@NotNull
                                                   @NotNull Reader reader)
                                            throws JSONException

Deserializes the data in the given Reader into an Object.

Parameters:

reader - The Reader containing the JSON data.

Returns:

An Object containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

deserializeArray

@Nullable
public static @Nullable JSONArray deserializeArray(@NotNull
                                                             @NotNull String data)
                                                      throws JSONException

Deserializes the given String data into a JSONArray.

Parameters:

data - The JSON data in String format.

Returns:

A JSONArray containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

deserializeArray

@Nullable
public static @Nullable JSONArray deserializeArray(@NotNull
                                                             @NotNull Reader reader)
                                                      throws JSONException

Deserializes the data in the given Reader into a JSONArray.

Parameters:

reader - The Reader containing the JSON data.

Returns:

A JSONArray containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

deserializeObject

@Nullable
public static @Nullable JSONObject deserializeObject(@NotNull
                                                               @NotNull String data)
                                                        throws JSONException

Deserializes the given String data into a JSONObject.

Parameters:

data - The JSON data in String format.

Returns:

A JSONObject containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

deserializeObject

@Nullable
public static @Nullable JSONObject deserializeObject(@NotNull
                                                               @NotNull Reader reader)
                                                        throws JSONException

Deserializes the data in the given Reader into a JSONObject.

Parameters:

reader - The Reader containing the JSON data.

Returns:

A JSONObject containing the deserialized JSON data.

Throws:

JSONException - If an error occurs while deserializing the data.

serialize

@NotNull
public static @NotNull String serialize(@Nullable
                                                 @Nullable Object data)
                                          throws JSONException

Serializes the given Object into String data.

Parameters:

data - The data as an Object to serialize into JSON format.

Returns:

A String representation of the given data.

Throws:

JSONException - If an error occurs while serializing the data.

format

@NotNull
public static @NotNull String format(@NotNull
                                              @NotNull String data)
                                       throws JSONException

Formats the given String JSON data into a human-readable format using indentation and newlines. The indentation character used is "\t", while the newline character used is "\n".

Parameters:

data - The JSON data as a String.

Returns:

The formatted JSON data as a String.

Throws:

JSONException - If an error occurs while formatting the data.

format

@NotNull
public static @NotNull String format(@NotNull
                                              @NotNull Reader reader)
                                       throws JSONException

Formats the JSON data in the given Reader into a human-readable format using indentation and newlines. The indentation character used is "\t", while the newline character used is "\n".

Parameters:

reader - The Reader containing the JSON data.

Returns:

The formatted JSON data as a String.

Throws:

JSONException - If an error occurs while formatting the data.

format

@NotNull
public static @NotNull String format(@NotNull
                                              @NotNull String data,
                                              @NotNull
                                              @NotNull String indent,
                                              @NotNull
                                              @NotNull String newline)
                                       throws JSONException

Formats the given String JSON data into a human-readable format using indentation and newlines, both of the caller's choice. This means the validity of the formatted JSON is dependent on the caller's choice of indentation and newlines.

Parameters:

data - The JSON data as a String.

indent - The String to use as an indent.

newline - The String to use as a newline.

Returns:

The formatted JSON data as a String.

Throws:

JSONException - If an error occurs while formatting the data.

format

@NotNull
public static @NotNull String format(@NotNull
                                              @NotNull Reader reader,
                                              @NotNull
                                              @NotNull String indent,
                                              @NotNull
                                              @NotNull String newline)
                                       throws JSONException

Formats the gSON data in the given Reader into a human-readable format using indentation and newlines, both of the caller's choice. This means the validity of the formatted JSON is dependent on the caller's choice of indentation and newlines.

Parameters:

reader - The Reader containing the JSON data.

indent - The String to use as an indent.

newline - The String to use as a newline.

Returns:

The formatted JSON data as a String.

Throws:

JSONException - If an error occurs while formatting the data.