com.github.dannil.scbjavaclient.utility

Class JsonUtility

java.lang.Object

com.github.dannil.scbjavaclient.utility.JsonUtility

public final class JsonUtility
extends Object

Utility class for converting JSON to Java objects.

Author:

Daniel Nilsson

Method Summary

Modifier and Type	Method and Description
static List<String>	getCodes(String content) Extracts the codes from the input.
static List<String>	getContentCodes(String json) Retrieves the contents codes from the specified JSON.
static boolean	isConventionalJson(com.fasterxml.jackson.databind.JsonNode node) Checks if the node is formatted as the specified conventional format.
static boolean	isQuery(com.fasterxml.jackson.databind.JsonNode node) Checks if the node is a query.
static <T> List<T>	jsonToListOf(com.fasterxml.jackson.databind.JsonNode node, Class<T> clazz) Converts the JsonNode into a list of the specified class.
static <T> List<T>	jsonToListOf(String json, Class<T> clazz) Converts the JSON string into a list of the specified class.
static com.fasterxml.jackson.databind.JsonNode	toConventionalJson(String json) Converts the non-conventional JSON response from the SCB API into a more conventional format, wrapped in a JsonNode.
static com.fasterxml.jackson.databind.JsonNode	toNode(String json) Parse the JSON string into a JsonNode object.
static com.fasterxml.jackson.databind.JsonNode	toNode(String json, String field) Parse the JSON string into a JsonNode object with the specified field as root field.

Methods inherited from class java.lang.Object

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

Method Detail

toNode

public static com.fasterxml.jackson.databind.JsonNode toNode(String json)

Parse the JSON string into a JsonNode object.

Parameters:

json - the JSON content

Returns:

a JsonNode object

toNode

public static com.fasterxml.jackson.databind.JsonNode toNode(String json,
                                                             String field)

Parse the JSON string into a JsonNode object with the specified field as root field.

Parameters:

json - the JSON content

field - the field in the JSON to become the root

Returns:

a JsonNode object with the specified field as root.

toConventionalJson

public static com.fasterxml.jackson.databind.JsonNode toConventionalJson(String json)

Converts the non-conventional JSON response from the SCB API into a more conventional format, wrapped in a JsonNode.

Parameters:

json - the json to format

Returns:

the formatted json

isConventionalJson

public static boolean isConventionalJson(com.fasterxml.jackson.databind.JsonNode node)

Checks if the node is formatted as the specified conventional format.

Parameters:

node - the node to check

Returns:

true if conventional format; otherwise false

isQuery

public static boolean isQuery(com.fasterxml.jackson.databind.JsonNode node)

Checks if the node is a query.

Parameters:

node - the node to check

Returns:

true if a query; otherwise false

jsonToListOf

public static <T> List<T> jsonToListOf(com.fasterxml.jackson.databind.JsonNode node,
                                       Class<T> clazz)

Converts the JsonNode into a list of the specified class.

Type Parameters:

T - the data type of the list

Parameters:

node - the node to process

clazz - the class to convert each JSON entry to

Returns:

a list of elements, which type is the specified class. Each element represents the corresponding entry in the JsonNode

jsonToListOf

public static <T> List<T> jsonToListOf(String json,
                                       Class<T> clazz)

Converts the JSON string into a list of the specified class.

Type Parameters:

T - the data type of the list

Parameters:

json - the json to process

clazz - the class to convert each JSON entry to

Returns:

a list of elements, which type is the specified class. Each element represents the corresponding entry in the JSON

getCodes

public static List<String> getCodes(String content)

Extracts the codes from the input.

Parameters:

content - the input which should be parsed

Returns:

a list of codes for the input

getContentCodes

public static List<String> getContentCodes(String json)

Retrieves the contents codes from the specified JSON.

Parameters:

json - the json to retrieve the contents codes from

Returns:

a list of the available contents codes