org.lightningj.paywall

Class JSONParsable

java.lang.Object

org.lightningj.paywall.JSONParsable

Direct Known Subclasses:

Amount, APIError, Invoice, JWTClaim, LightningEvent, LNDLightningHandlerContext, NodeInfo, PaymentEvent, PaymentOption, PreImageData, Rate, Response, Result, Token

public abstract class JSONParsable
extends java.lang.Object

Base class for value classes that should be JSON Parsable. Contains helper methods to convert to and from JSON and a toString() implementation that generates a pretty printed json string. Created by Philip Vendil on 2018-10-17.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JSONParsable() Base empty constructor
protected	JSONParsable(javax.json.JsonObject jsonObject) JSON Parseable constructor

Method Summary

Modifier and Type	Method and Description
protected void	add(javax.json.JsonObjectBuilder jsonObjectBuilder, java.lang.String key, java.lang.Object value) Method to add a field to a json object builder.
protected void	addB58(javax.json.JsonObjectBuilder jsonObjectBuilder, java.lang.String key, java.lang.String value) Special method when adding a B58 encoded value.
protected void	addNotRequired(javax.json.JsonObjectBuilder jsonObjectBuilder, java.lang.String key, java.lang.Object value) Help method that can be used in convertToJson implementations to set a key in json if not null, otherwise the key is skipped.
protected void	addNotRequiredB58(javax.json.JsonObjectBuilder jsonObjectBuilder, java.lang.String key, java.lang.String value) Special method when adding a B58 encoded value.
abstract void	convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder) Method that should set the objects property to Json representation.
protected java.lang.Boolean	getBoolean(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a boolean value if set in JsonObject otherwise returns null.
protected java.lang.Boolean	getBooleanIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a boolean value
protected byte[]	getByteArrayFromB58(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a b58 string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.
protected byte[]	getByteArrayFromB58IfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a b58 string value and decode it into byte[]
protected byte[]	getByteArrayFromB64(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a b64 string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.
protected byte[]	getByteArrayFromB64IfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a b64 string value and decode it into byte[]
protected byte[]	getByteArrayFromHex(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a hex string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.
protected byte[]	getByteArrayFromHexIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a hex string value and decode it into byte[]
protected java.util.Date	getDate(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a Date value in "yyyy-MM-ddTHH:mm:ss.SSSZ" format.
protected java.util.Date	getDateIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a Date value
protected java.lang.Double	getDouble(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a double value
protected java.lang.Double	getDoubleIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a double value
protected java.lang.Integer	getInt(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a int value if set in JsonObject otherwise returns null or throws JsonException if required.
protected java.lang.Integer	getIntIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a int value
protected javax.json.JsonArray	getJsonArray(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a json array if set in JsonObject otherwise returns null.
protected javax.json.JsonArray	getJsonArrayIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a json array
protected javax.json.JsonObject	getJsonObject(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a json object if set in JsonObject otherwise returns null.
protected javax.json.JsonObject	getJsonObjectIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a json object
protected java.lang.Long	getLong(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a long value if set in JsonObject otherwise returns null or throws JsonException if required.
protected java.lang.Long	getLongIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a long value
protected java.lang.String	getString(javax.json.JsonObject object, java.lang.String key, boolean required) Help method used in parseJson implementation to fetch a string value if set in JsonObject otherwise returns null or throws JsonException if required.
protected java.lang.String	getStringIfSet(javax.json.JsonObject object, java.lang.String key) Help method used in parseJson implementation to fetch a string value
abstract void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
javax.json.JsonObjectBuilder	toJson() Help method to convert object into JSON as a JsonObjectBuilder.
java.lang.String	toJsonAsString(boolean prettyPrint) Help method to convert the data to a String representation.
java.lang.String	toString() Converts data content to pretty printed Json string.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONParsable

protected JSONParsable()

Base empty constructor

JSONParsable

protected JSONParsable(javax.json.JsonObject jsonObject)
                throws javax.json.JsonException

JSON Parseable constructor

Parameters:

jsonObject - the jsonObject to parse.

Throws:

javax.json.JsonException

Method Detail

toJson

public javax.json.JsonObjectBuilder toJson()
                                    throws javax.json.JsonException

Help method to convert object into JSON as a JsonObjectBuilder.

Returns:

the JsonObjectBuilder of related object.

Throws:

javax.json.JsonException

toJsonAsString

public java.lang.String toJsonAsString(boolean prettyPrint)
                                throws javax.json.JsonException

Help method to convert the data to a String representation.

Parameters:

prettyPrint - true if generated string should be pretty printed, otherwise compact.

Returns:

JSON representation of the data.

Throws:

javax.json.JsonException - if problems occurred converting object to JSON.

convertToJson

public abstract void convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder)
                            throws javax.json.JsonException

Method that should set the objects property to Json representation.

Parameters:

jsonObjectBuilder - the json object build to use to set key/values in json

Throws:

javax.json.JsonException - if problems occurred converting object to JSON.

parseJson

public abstract void parseJson(javax.json.JsonObject jsonObject)
                        throws javax.json.JsonException

Method to read all properties from a JsonObject into this value object.

Parameters:

jsonObject - the json object to read key and values from and set object properties.

Throws:

javax.json.JsonException - if problems occurred converting object from JSON.

addNotRequired

protected void addNotRequired(javax.json.JsonObjectBuilder jsonObjectBuilder,
                              java.lang.String key,
                              java.lang.Object value)

Help method that can be used in convertToJson implementations to set a key in json if not null, otherwise the key is skipped.

Parameters:

jsonObjectBuilder - the objects jsonObjectBuilder

key - the key of json object to add.

value - the value to add.

add

protected void add(javax.json.JsonObjectBuilder jsonObjectBuilder,
                   java.lang.String key,
                   java.lang.Object value)
            throws javax.json.JsonException

Method to add a field to a json object builder.

Parameters:

jsonObjectBuilder - the objects jsonObjectBuilder

key - the key of json object to add.

value - the value to add.

Throws:

javax.json.JsonException - if json problems occurred.

addB58

protected void addB58(javax.json.JsonObjectBuilder jsonObjectBuilder,
                      java.lang.String key,
                      java.lang.String value)
               throws javax.json.JsonException

Special method when adding a B58 encoded value.

Parameters:

jsonObjectBuilder - the objects jsonObjectBuilder

key - the key of json object to add.

value - the value to add.

Throws:

javax.json.JsonException - if json problems occurred.

addNotRequiredB58

protected void addNotRequiredB58(javax.json.JsonObjectBuilder jsonObjectBuilder,
                                 java.lang.String key,
                                 java.lang.String value)

Special method when adding a B58 encoded value.

Parameters:

jsonObjectBuilder - the objects jsonObjectBuilder

key - the key of json object to add.

value - the value to add.

Throws:

javax.json.JsonException - if json problems occurred.

getStringIfSet

protected java.lang.String getStringIfSet(javax.json.JsonObject object,
                                          java.lang.String key)

Help method used in parseJson implementation to fetch a string value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getString

protected java.lang.String getString(javax.json.JsonObject object,
                                     java.lang.String key,
                                     boolean required)
                              throws javax.json.JsonException

Help method used in parseJson implementation to fetch a string value if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getByteArrayFromHexIfSet

protected byte[] getByteArrayFromHexIfSet(javax.json.JsonObject object,
                                          java.lang.String key)

Help method used in parseJson implementation to fetch a hex string value and decode it into byte[]

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getByteArrayFromHex

protected byte[] getByteArrayFromHex(javax.json.JsonObject object,
                                     java.lang.String key,
                                     boolean required)
                              throws javax.json.JsonException

Help method used in parseJson implementation to fetch a hex string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getByteArrayFromB64IfSet

protected byte[] getByteArrayFromB64IfSet(javax.json.JsonObject object,
                                          java.lang.String key)

Help method used in parseJson implementation to fetch a b64 string value and decode it into byte[]

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getByteArrayFromB64

protected byte[] getByteArrayFromB64(javax.json.JsonObject object,
                                     java.lang.String key,
                                     boolean required)
                              throws javax.json.JsonException

Help method used in parseJson implementation to fetch a b64 string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getByteArrayFromB58IfSet

protected byte[] getByteArrayFromB58IfSet(javax.json.JsonObject object,
                                          java.lang.String key)

Help method used in parseJson implementation to fetch a b58 string value and decode it into byte[]

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getByteArrayFromB58

protected byte[] getByteArrayFromB58(javax.json.JsonObject object,
                                     java.lang.String key,
                                     boolean required)
                              throws javax.json.JsonException

Help method used in parseJson implementation to fetch a b58 string value and decode it into byte array if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getLongIfSet

protected java.lang.Long getLongIfSet(javax.json.JsonObject object,
                                      java.lang.String key)

Help method used in parseJson implementation to fetch a long value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getLong

protected java.lang.Long getLong(javax.json.JsonObject object,
                                 java.lang.String key,
                                 boolean required)
                          throws javax.json.JsonException

Help method used in parseJson implementation to fetch a long value if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getDateIfSet

protected java.util.Date getDateIfSet(javax.json.JsonObject object,
                                      java.lang.String key)

Help method used in parseJson implementation to fetch a Date value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getDate

protected java.util.Date getDate(javax.json.JsonObject object,
                                 java.lang.String key,
                                 boolean required)
                          throws javax.json.JsonException

Help method used in parseJson implementation to fetch a Date value in "yyyy-MM-ddTHH:mm:ss.SSSZ" format. if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getIntIfSet

protected java.lang.Integer getIntIfSet(javax.json.JsonObject object,
                                        java.lang.String key)

Help method used in parseJson implementation to fetch a int value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getInt

protected java.lang.Integer getInt(javax.json.JsonObject object,
                                   java.lang.String key,
                                   boolean required)
                            throws javax.json.JsonException

Help method used in parseJson implementation to fetch a int value if set in JsonObject otherwise returns null or throws JsonException if required.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getBooleanIfSet

protected java.lang.Boolean getBooleanIfSet(javax.json.JsonObject object,
                                            java.lang.String key)

Help method used in parseJson implementation to fetch a boolean value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getBoolean

protected java.lang.Boolean getBoolean(javax.json.JsonObject object,
                                       java.lang.String key,
                                       boolean required)
                                throws javax.json.JsonException

Help method used in parseJson implementation to fetch a boolean value if set in JsonObject otherwise returns null.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getDoubleIfSet

protected java.lang.Double getDoubleIfSet(javax.json.JsonObject object,
                                          java.lang.String key)

Help method used in parseJson implementation to fetch a double value

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getDouble

protected java.lang.Double getDouble(javax.json.JsonObject object,
                                     java.lang.String key,
                                     boolean required)
                              throws javax.json.JsonException

Help method used in parseJson implementation to fetch a double value

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getJsonObjectIfSet

protected javax.json.JsonObject getJsonObjectIfSet(javax.json.JsonObject object,
                                                   java.lang.String key)

Help method used in parseJson implementation to fetch a json object

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getJsonObject

protected javax.json.JsonObject getJsonObject(javax.json.JsonObject object,
                                              java.lang.String key,
                                              boolean required)
                                       throws javax.json.JsonException

Help method used in parseJson implementation to fetch a json object if set in JsonObject otherwise returns null.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

getJsonArrayIfSet

protected javax.json.JsonArray getJsonArrayIfSet(javax.json.JsonObject object,
                                                 java.lang.String key)

Help method used in parseJson implementation to fetch a json array

Parameters:

object - the related json object

key - the key of field to fetch

Returns:

if set in JsonObject otherwise returns null.

getJsonArray

protected javax.json.JsonArray getJsonArray(javax.json.JsonObject object,
                                            java.lang.String key,
                                            boolean required)
                                     throws javax.json.JsonException

Help method used in parseJson implementation to fetch a json array if set in JsonObject otherwise returns null.

Parameters:

object - the related json object

key - the key of field to fetch

required - true if exception should be thrown if field doesn't exist.

Returns:

the related field.

Throws:

javax.json.JsonException - if field is not set but required.

toString

public java.lang.String toString()

Converts data content to pretty printed Json string.

Overrides:

toString in class java.lang.Object

Returns:

string representation of json object.