Interface IssuedCurrencyAmount
- All Superinterfaces:
CurrencyAmount
- All Known Implementing Classes:
ImmutableIssuedCurrencyAmount
A
CurrencyAmount for Issued Currencies on the XRP Ledger.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe largest possible negative value that anIssuedCurrencyAmountcan have.static final StringThe maximum value that anIssuedCurrencyAmountcan have.static final StringThe smallest possible positive value that anIssuedCurrencyAmountcan have.static final StringThe minimum value that anIssuedCurrencyAmountcan have.Fields inherited from interface org.xrpl.xrpl4j.model.transactions.CurrencyAmount
MAX_XRP, MAX_XRP_BD, MAX_XRP_IN_DROPS, ONE_XRP_IN_DROPS -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Construct a builder for this class.currency()Arbitrary code for currency to issue.default booleanIndicates whether this amount is positive or negative.issuer()Unique accountAddressof the entity issuing the currency.value()Quoted decimal representation of the amount of currency.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.CurrencyAmount
handle, map
-
Field Details
-
MAX_VALUE
The maximum value that anIssuedCurrencyAmountcan have.- See Also:
-
MIN_VALUE
The minimum value that anIssuedCurrencyAmountcan have.- See Also:
-
MIN_POSITIVE_VALUE
The smallest possible positive value that anIssuedCurrencyAmountcan have. Put another way, this value is the closest anIssuedCurrencyAmount'svalue()can be to zero if it is positive.- See Also:
-
MAX_NEGATIVE_VALUE
The largest possible negative value that anIssuedCurrencyAmountcan have. Put another way, this value is the closest anIssuedCurrencyAmount'svalue()can be to zero if it is negative.- See Also:
-
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableIssuedCurrencyAmount.Builder.
-
value
String value()Quoted decimal representation of the amount of currency. This can include scientific notation, such as 1.23e11 meaning 123,000,000,000. Both e and E may be used. Note that while this implementation merely holds aStringwith no value restrictions, the XRP Ledger does not tolerate unlimited precision values. Instead, non-XRP values (i.e., values held in this object) can have up to 16 decimal digits of precision, with a maximum value of 9999999999999999e80. The smallest positive non-XRP value is 1e-81.- Returns:
- A
Stringcontaining the amount of this issued currency.
-
currency
String currency()Arbitrary code for currency to issue. Cannot be XRP.- Returns:
- A
Stringcontaining the currency code.
-
issuer
Address issuer()Unique accountAddressof the entity issuing the currency. In other words, the person or business where the currency can be redeemed.- Returns:
- The
Addressof the account of the issuer of this currency.
-
isNegative
@Derived @Auxiliary default boolean isNegative()Indicates whether this amount is positive or negative.- Specified by:
isNegativein interfaceCurrencyAmount- Returns:
trueif this amount is negative;falseotherwise (i.e., if the value is 0 or positive).
-