Interface IssuedCurrencyAmount

All Superinterfaces:
CurrencyAmount
All Known Implementing Classes:
ImmutableIssuedCurrencyAmount

@Immutable public interface IssuedCurrencyAmount extends CurrencyAmount
A CurrencyAmount for Issued Currencies on the XRP Ledger.
See Also:
  • "https://xrpl.org/rippleapi-reference.html#value"
  • Field Details

  • 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 a String with 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 String containing the amount of this issued currency.
    • currency

      String currency()
      Arbitrary code for currency to issue. Cannot be XRP.
      Returns:
      A String containing the currency code.
    • issuer

      Address issuer()
      Unique account Address of the entity issuing the currency. In other words, the person or business where the currency can be redeemed.
      Returns:
      The Address of the account of the issuer of this currency.
    • isNegative

      @Derived @Auxiliary default boolean isNegative()
      Indicates whether this amount is positive or negative.
      Specified by:
      isNegative in interface CurrencyAmount
      Returns:
      true if this amount is negative; false otherwise (i.e., if the value is 0 or positive).