com.github.dannil.scbjavaclient.format.json

Class JsonCustomResponseFormat

java.lang.Object

com.github.dannil.scbjavaclient.format.json.JsonCustomResponseFormat

All Implemented Interfaces:

IJsonResponseFormat

public final class JsonCustomResponseFormat
extends Object
implements IJsonResponseFormat

Class which encapsulates behavior for the custom JSON response format. Note that this class is immutable; to change the containing JSON, a new class needs to be instantiated.

Author:

Daniel Nilsson

Constructor Summary

Constructors

Constructor and Description
JsonCustomResponseFormat(String json) Default constructor.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	format() Formats the JSON according to the specified implementing format.
boolean	isFormatted() Checks if the JSON is formatted as the specified format.
<T> List<T>	toListOf(Class<T> clazz) Converts the JSON string into a list of the specified class.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonCustomResponseFormat

public JsonCustomResponseFormat(String json)

Default constructor.

Parameters:

json - the json to format

Method Detail

format

public com.fasterxml.jackson.databind.JsonNode format()

Description copied from interface: IJsonResponseFormat

Formats the JSON according to the specified implementing format.

Specified by:

format in interface IJsonResponseFormat

Returns:

a formatted JsonNode

isFormatted

public boolean isFormatted()

Description copied from interface: IJsonResponseFormat

Checks if the JSON is formatted as the specified format.

Specified by:

isFormatted in interface IJsonResponseFormat

Returns:

true if the JSON is formatted as the implementing format

toListOf

public <T> List<T> toListOf(Class<T> clazz)

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

Type Parameters:

T - the data type of the list

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object