net.covers1624.quack.gson

Class JsonUtils

java.lang.Object

net.covers1624.quack.gson.JsonUtils

public class JsonUtils
extends java.lang.Object

Contains utilities for reading/writing and interacting with Json.

Many of the parse/write methods will take a Type object instead of a Class object. This is to allow deserializing objects which have direct generic parameters through the use of TypeToken. You can use TypeToken as follows: private static final Type STRING_LIST_TYPE = new com.google.gson.reflect.TypeToken<List<String>>(){ }.getType();.

Created by covers1624 on 11/11/21.

Constructor Summary

Constructors

Constructor and Description
JsonUtils()

Method Summary

Modifier and Type	Method and Description
static JsonPrimitive	getAsPrimitive(JsonObject obj, java.lang.String key) Try and get a JsonPrimitive child from the given JsonObject.
static JsonPrimitive	getAsPrimitiveOrNull(JsonObject obj, java.lang.String key) Try and get a JsonPrimitive child from the given JsonObject.
static int	getInt(JsonObject obj, java.lang.String key) Try and get an int child from the given JsonObject.
static int	getInt(JsonObject obj, java.lang.String key, int default_) Try and get an int child from the given JsonObject.
static java.lang.String	getString(JsonObject obj, java.lang.String key) Try and get a String child from the given JsonObject.
static java.lang.String	getString(JsonObject obj, java.lang.String key, java.lang.String default_) Try and get an String child from the given JsonObject.
static <T> T	parse(Gson gson, java.io.InputStream is, java.lang.reflect.Type t) Deserialize Json from the given InputStream as the given Type.
static <T> T	parse(Gson gson, java.nio.file.Path path, java.lang.reflect.Type t) Deserialize Json from the given Path as the given Type.
static <T> T	parse(Gson gson, java.io.Reader reader, java.lang.reflect.Type t) Deserialize Json from the given Reader as the given Type.
static <T> T	parse(Gson gson, java.lang.String str, java.lang.reflect.Type t) Deserialize Json from the given String as the given Type.
static JsonElement	parseRaw(java.io.InputStream is) Deserialize Json from the given InputStream as a raw JsonElement.
static JsonElement	parseRaw(java.nio.file.Path path) Deserialize Json from the given Path as a raw JsonElement.
static JsonElement	parseRaw(java.io.Reader reader) Deserialize Json from the given Reader as a raw JsonElement.
static JsonElement	parseRaw(java.lang.String str) Deserialize Json from the given String as a raw JsonElement.
static void	write(Gson gson, java.io.OutputStream os, java.lang.Object instance) Serialize the provided Object to Json and write to the given OutputStream.
static void	write(Gson gson, java.io.OutputStream os, java.lang.Object instance, java.lang.reflect.Type t) Serialize the provided Object to Json and write to the given OutputStream.
static void	write(Gson gson, java.nio.file.Path path, java.lang.Object instance) Serialize the provided Object to Json and write to the given Path.
static void	write(Gson gson, java.nio.file.Path path, java.lang.Object instance, java.lang.reflect.Type t) Serialize the provided Object to json and write it to the given Path.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUtils

public JsonUtils()

Method Detail

parse

public static <T> T parse(Gson gson,
                          java.nio.file.Path path,
                          java.lang.reflect.Type t)
                   throws java.io.IOException,
                          JsonParseException

Deserialize Json from the given Path as the given Type.

Parameters:

gson - The Gson instance to use.

path - The Path to read from.

t - The Type to deserialize from.

Returns:

The Object deserialized from Json.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parse

public static <T> T parse(Gson gson,
                          java.lang.String str,
                          java.lang.reflect.Type t)
                   throws java.io.IOException,
                          JsonParseException

Deserialize Json from the given String as the given Type.

Parameters:

gson - The Gson instance to use.

str - The String representing the json to parse.

t - The Type to deserialize from.

Returns:

The Object deserialized from Json.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parse

public static <T> T parse(Gson gson,
                          java.io.InputStream is,
                          java.lang.reflect.Type t)
                   throws java.io.IOException,
                          JsonParseException

Deserialize Json from the given InputStream as the given Type.

Parameters:

gson - The Gson instance to use.

is - The InputStream to read from.

t - The Type to deserialize from.

Returns:

The Object deserialized from Json.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parse

public static <T> T parse(Gson gson,
                          java.io.Reader reader,
                          java.lang.reflect.Type t)
                   throws java.io.IOException,
                          JsonParseException

Deserialize Json from the given Reader as the given Type.

Parameters:

gson - The Gson instance to use.

reader - The Reader to read from.

t - The Type to deserialize from.

Returns:

The Object deserialized from Json.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parseRaw

public static JsonElement parseRaw(java.nio.file.Path path)
                            throws java.io.IOException,
                                   JsonParseException

Deserialize Json from the given Path as a raw JsonElement.

Parameters:

path - The Path to read from.

Returns:

The JsonElement.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parseRaw

public static JsonElement parseRaw(java.lang.String str)
                            throws java.io.IOException,
                                   JsonParseException

Deserialize Json from the given String as a raw JsonElement.

Parameters:

str - The String representing the json to parse.

Returns:

The JsonElement.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parseRaw

public static JsonElement parseRaw(java.io.InputStream is)
                            throws java.io.IOException,
                                   JsonParseException

Deserialize Json from the given InputStream as a raw JsonElement.

Parameters:

is - The InputStream to read from.

Returns:

The JsonElement.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

parseRaw

public static JsonElement parseRaw(java.io.Reader reader)
                            throws java.io.IOException,
                                   JsonParseException

Deserialize Json from the given Reader as a raw JsonElement.

Parameters:

reader - The Reader to read from.

Returns:

The JsonElement.

Throws:

JsonParseException - Propagated from Gson#fromJson(Reader, Type), thrown when Gson encounters an error deserializing the object.

java.io.IOException - Thrown when an IO error occurs.

write

public static void write(Gson gson,
                         java.nio.file.Path path,
                         java.lang.Object instance)
                  throws java.io.IOException,
                         JsonIOException

Serialize the provided Object to Json and write to the given Path.

Use this method when your instance doesn't have any direct generic parameters.

Parameters:

gson - The Gson instance to use.

path - The Path to write to.

instance - The Object instance to serialize.

Throws:

JsonIOException - Propagated from Gson#toJson(Object, Type, Appendable), thrown when Gson encounters an error serializing the instance.

java.io.IOException - Thrown when an IO error occurs.

write

public static void write(Gson gson,
                         java.nio.file.Path path,
                         java.lang.Object instance,
                         java.lang.reflect.Type t)
                  throws java.io.IOException,
                         JsonIOException

Serialize the provided Object to json and write it to the given Path.

Use this method directly if your instance has direct generic parameters.

Parameters:

gson - The Gson instance to use.

path - The Path to write to.

instance - The Object instance to serialize.

t - The Type of the Object instance.

Throws:

JsonIOException - Propagated from Gson#toJson(Object, Type, Appendable), thrown when Gson encounters an error serializing the instance.

java.io.IOException - Thrown when an IO error occurs.

write

public static void write(Gson gson,
                         java.io.OutputStream os,
                         java.lang.Object instance)
                  throws java.io.IOException,
                         JsonIOException

Serialize the provided Object to Json and write to the given OutputStream.

Use this method when your instance doesn't have any direct generic parameters.

Parameters:

gson - The Gson instance to use.

os - The OutputStream to write to.

instance - The Object instance to serialize.

Throws:

JsonIOException - Propagated from Gson#toJson(Object, Type, Appendable), thrown when Gson encounters an error serializing the instance.

java.io.IOException - Thrown when an IO error occurs.

write

public static void write(Gson gson,
                         java.io.OutputStream os,
                         java.lang.Object instance,
                         java.lang.reflect.Type t)
                  throws java.io.IOException,
                         JsonIOException

Serialize the provided Object to Json and write to the given OutputStream.

Use this method directly if your instance has direct generic parameters.

Parameters:

gson - The Gson instance to use.

os - The OutputStream to write to.

instance - The Object instance to write.

t - The Type of the Object instance.

Throws:

JsonIOException - Propagated from Gson#toJson(Object, Type, Appendable), thrown when Gson encounters an error serializing the instance.

java.io.IOException - Thrown when an IO error occurs.

getAsPrimitive

public static JsonPrimitive getAsPrimitive(JsonObject obj,
                                           java.lang.String key)
                                    throws JsonParseException

Try and get a JsonPrimitive child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

Returns:

The JsonPrimitive.

Throws:

JsonParseException - If the given child did not exist, or was not a JsonPrimitive.

getAsPrimitiveOrNull

public static JsonPrimitive getAsPrimitiveOrNull(JsonObject obj,
                                                 java.lang.String key)

Try and get a JsonPrimitive child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

Returns:

The JsonPrimitive, or null if the child does not exist, or is not a JsonPrimitive.

getInt

public static int getInt(JsonObject obj,
                         java.lang.String key)
                  throws JsonParseException

Try and get an int child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

Returns:

The integer.

Throws:

JsonParseException - If the given child did not exist, was not a JsonPrimitive, or was not a Number.

getInt

public static int getInt(JsonObject obj,
                         java.lang.String key,
                         int default_)

Try and get an int child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

default_ - The default value to return, in the event that the child does not exist, is not a JsonPrimitive, or is not a Number.

Returns:

The integer. Otherwise, default_.

getString

public static java.lang.String getString(JsonObject obj,
                                         java.lang.String key)
                                  throws JsonParseException

Try and get a String child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

Returns:

The String.

Throws:

JsonParseException - If the given child did not exist, was not a JsonPrimitive, or was not a String.

getString

public static java.lang.String getString(JsonObject obj,
                                         java.lang.String key,
                                         java.lang.String default_)

Try and get an String child from the given JsonObject.

Parameters:

obj - The JsonObject to get the child from.

key - The name of the child.

default_ - The default value to return, in the event that the child does not exist, is not a JsonPrimitive, or is not a Number.

Returns:

The String. Otherwise, default_.