mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2024-11-20 02:09:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add missing JavaDocs for ExchangeRate.

Browse Source
This commit is contained in:
Andreas Schildbach 2014-10-12 19:11:04 +02:00
parent 1a476af542
commit 8c99e61e01
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/src/main/java/org/bitcoinj/utils/ExchangeRate.java
View File

@ -31,16 +31,22 @@ public class ExchangeRate implements Serializable {
public final Coin coin; public final Coin coin;
public final Fiat fiat; public final Fiat fiat;
/** Construct exchange rate. This amount of coin is worth that amount of fiat. */
public ExchangeRate(Coin coin, Fiat fiat) { public ExchangeRate(Coin coin, Fiat fiat) {
this.coin = coin; this.coin = coin;
this.fiat = fiat; this.fiat = fiat;
} }
/** Construct exchange rate. One coin is worth this amount of fiat. */
public ExchangeRate(Fiat fiat) { public ExchangeRate(Fiat fiat) {
this.coin = Coin.COIN; this.coin = Coin.COIN;
this.fiat = fiat; this.fiat = fiat;
} }
/**
* Convert a coin amount to a fiat amount using this exchange rate.
* @throws ArithmeticException if the converted fiat amount is too high or too low.
*/
public Fiat coinToFiat(Coin convertCoin) { public Fiat coinToFiat(Coin convertCoin) {
// Use BigInteger because it's much easier to maintain full precision without overflowing. // Use BigInteger because it's much easier to maintain full precision without overflowing.
final BigInteger converted = BigInteger.valueOf(convertCoin.value).multiply(BigInteger.valueOf(fiat.value)) final BigInteger converted = BigInteger.valueOf(convertCoin.value).multiply(BigInteger.valueOf(fiat.value))
@ -51,6 +57,10 @@ public class ExchangeRate implements Serializable {
return Fiat.valueOf(fiat.currencyCode, converted.longValue()); return Fiat.valueOf(fiat.currencyCode, converted.longValue());
} }
/**
* Convert a fiat amount to a coin amount using this exchange rate.
* @throws ArithmeticException if the converted coin amount is too high or too low.
*/
public Coin fiatToCoin(Fiat convertFiat) { public Coin fiatToCoin(Fiat convertFiat) {
checkArgument(convertFiat.currencyCode.equals(fiat.currencyCode), "Currency mismatch: %s vs %s", checkArgument(convertFiat.currencyCode.equals(fiat.currencyCode), "Currency mismatch: %s vs %s",
convertFiat.currencyCode, fiat.currencyCode); convertFiat.currencyCode, fiat.currencyCode);