org.lightningj.paywall.vo.amount

Class CryptoAmount

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.vo.amount.Amount

org.lightningj.paywall.vo.amount.CryptoAmount

Direct Known Subclasses:

BTC

public class CryptoAmount
extends Amount

Amount specified in crypto currency where value is the amount in its smallest demination. For example for BTC should the value be specified in satoshis and not whole Bitcoin. It is also possible to specify the amount in sub unit using the optional magnitude field. For example to specify amount in millisatoshis set magnitude to MILLI. Created by Philip Vendil on 2018-11-07.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENCY_CODE_BTC
static java.lang.String	CURRENCY_CODE_LTC
protected java.lang.String	currencyCode
protected Magnetude	magnetude
protected long	value

Fields inherited from class org.lightningj.paywall.vo.amount.Amount

type

Constructor Summary

Constructors

Constructor and Description
CryptoAmount() Empty Constructor
CryptoAmount(javax.json.JsonObject jsonObject) JSON Parseable constructor
CryptoAmount(long value, java.lang.String currencyCode) Default Constructor, without magnitude
CryptoAmount(long value, java.lang.String currencyCode, Magnetude magnetude) Default Constructor

Method Summary

Modifier and Type	Method and Description
void	convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder) Method that should set the objects property to Json representation.
java.lang.String	getCurrencyCode()
Magnetude	getMagnetude()
long	getValue()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setCurrencyCode(java.lang.String currencyCode)
void	setMagnetude(Magnetude magnetude)
void	setValue(long value)

Methods inherited from class org.lightningj.paywall.vo.amount.Amount

getType, parseAmountObject

Methods inherited from class org.lightningj.paywall.JSONParsable

add, addB58, addNotRequired, addNotRequiredB58, getBoolean, getBooleanIfSet, getByteArrayFromB58, getByteArrayFromB58IfSet, getByteArrayFromB64, getByteArrayFromB64IfSet, getByteArrayFromHex, getByteArrayFromHexIfSet, getDate, getDateIfSet, getDouble, getDoubleIfSet, getInt, getIntIfSet, getJsonArray, getJsonArrayIfSet, getJsonObject, getJsonObjectIfSet, getLong, getLongIfSet, getString, getStringIfSet, toJson, toJsonAsString, toString

Methods inherited from class java.lang.Object

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

Field Detail

CURRENCY_CODE_BTC

public static final java.lang.String CURRENCY_CODE_BTC

See Also:

Constant Field Values

CURRENCY_CODE_LTC

public static final java.lang.String CURRENCY_CODE_LTC

See Also:

Constant Field Values

value

protected long value

currencyCode

protected java.lang.String currencyCode

magnetude

protected Magnetude magnetude

Constructor Detail

CryptoAmount

public CryptoAmount()

Empty Constructor

CryptoAmount

public CryptoAmount(long value,
                    java.lang.String currencyCode)

Default Constructor, without magnitude

Parameters:

value - the amount in smallest unit for the cryptocurrency, for example set in satoshis for BTC.

currencyCode - the currency code, for example "BTC".

CryptoAmount

public CryptoAmount(long value,
                    java.lang.String currencyCode,
                    Magnetude magnetude)

Default Constructor

Parameters:

value - the amount in smallest unit for the cryptocurrency, for example set in satoshis for BTC.

currencyCode - the currency code, for example "BTC".

magnetude - If sub units to the value it is possible to specify a magnitude. for example set to MILLI for millisatoshis for BTC.

CryptoAmount

public CryptoAmount(javax.json.JsonObject jsonObject)
             throws javax.json.JsonException

JSON Parseable constructor

Parameters:

jsonObject - the jsonObject to parse.

Throws:

javax.json.JsonException - if problems occurred parsing the json data.

Method Detail

getValue

public long getValue()

Returns:

the amount in smallest unit for the cryptocurrency, for example set in satoshis for BTC.

setValue

public void setValue(long value)

Parameters:

value - the amount in smallest unit for the cryptocurrency, for example set in satoshis for BTC.

getCurrencyCode

public java.lang.String getCurrencyCode()

Returns:

the currency code, for example "BTC".

setCurrencyCode

public void setCurrencyCode(java.lang.String currencyCode)

Parameters:

currencyCode - the currency code, for example "BTC".

getMagnetude

public Magnetude getMagnetude()

Returns:

If sub units to the value it is possible to specify a magnitude. for example set to MILLI for millisatoshis for BTC.

setMagnetude

public void setMagnetude(Magnetude magnetude)

Parameters:

magnetude - If sub units to the value it is possible to specify a magnitude. for example set to MILLI for millisatoshis for BTC.

convertToJson

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

Method that should set the objects property to Json representation.

Overrides:

convertToJson in class Amount

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 void parseJson(javax.json.JsonObject jsonObject)
               throws javax.json.JsonException

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

Specified by:

parseJson in class JSONParsable

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.