Package jp.gopay.sdk.models.common

Class MoneyLike

java.lang.Object

jp.gopay.sdk.models.response.GoPayResponse

jp.gopay.sdk.models.common.MoneyLike

public class MoneyLike
extends GoPayResponse

A class that represents monetary quantities with an amount and a currency.

Constructor Summary

Constructors

Constructor	Description
MoneyLike(BigInteger amount, String currency)

Method Summary

Modifier and Type	Method	Description
org.joda.money.Money	asJodaMoney()	Convert this instance to its Joda Money equivalent
int	compareTo(MoneyLike other)	Compares this to another instance of MoneyLike
boolean	equals(Object obj)
BigInteger	getAmount()
String	getCurrency()
MoneyLike	minus(BigInteger amountToSubtract)	Subtraction operation.
MoneyLike	minus(MoneyLike other)	Subtraction operation between two instances of MoneyLike
MoneyLike	plus(BigInteger amountToAdd)	Addition operation.
MoneyLike	plus(MoneyLike other)	Addition operation between two instances of MoneyLike.

Methods inherited from class jp.gopay.sdk.models.response.GoPayResponse

getIdempotencyStatus, setIdempotencyStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

MoneyLike

public MoneyLike(BigInteger amount,
                 String currency)

Method Detail

getAmount

public BigInteger getAmount()

getCurrency

public String getCurrency()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

asJodaMoney

public org.joda.money.Money asJodaMoney()

Convert this instance to its Joda Money equivalent

Returns:

an instance of Joda Money. The amount takes into consideration decimal places.

compareTo

public int compareTo(MoneyLike other)
              throws SDKException

Compares this to another instance of MoneyLike

Parameters:

other -

Returns:

As in the JodaMoney equivalent, -1 if Less Than , 0 if Equal and 1 if Greater Than

Throws:

SDKException - if the currencies differ.

plus

public MoneyLike plus(BigInteger amountToAdd)

Addition operation. Assumes that `amountToAdd` is in the same currency.

Parameters:

amountToAdd -

Returns:

a new instance of MoneyLike with the altered amount.

plus

public MoneyLike plus(MoneyLike other)
               throws SDKException

Addition operation between two instances of MoneyLike.

Parameters:

other -

Returns:

a new instance of MoneyLike with the altered amount.

Throws:

SDKException - if the currencies differ.

minus

public MoneyLike minus(BigInteger amountToSubtract)

Subtraction operation. Assumes that `amountToSubtract` is in the same currency.

Parameters:

amountToSubtract -

Returns:

a new instance of MoneyLike with the altered amount.

minus

public MoneyLike minus(MoneyLike other)
                throws SDKException

Subtraction operation between two instances of MoneyLike

Parameters:

other -

Returns:

a new instance of MoneyLike with the altered amount.

Throws:

SDKException - if the currencies differ.