java.lang.Object
org.xrpl.xrpl4j.model.transactions.Memo
Direct Known Subclasses:
ImmutableMemo

@Immutable public abstract class Memo extends Object
Contains arbitrary messaging data within an XRPL Transaction.

The MemoType and MemoFormat fields should only consist of the following characters: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$%26'()*+,;=%

The Memos field is limited to no more than 1 KB in size (when serialized in binary format).

See Also:
  • "https://xrpl.org/transaction-common-fields.html#memos-field"
  • Constructor Details

    • Memo

      public Memo()
  • Method Details

    • withPlaintext

      public static ImmutableMemo.Builder withPlaintext(String plaintext)
      Construct a ImmutableMemo.Builder by properly hex-encoding plaintext.
      Parameters:
      plaintext - A UTF-8 String.
      Returns:
      A ImmutableMemo.Builder.
    • builder

      public static ImmutableMemo.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableMemo.Builder.
    • memoData

      public abstract Optional<String> memoData()
      Arbitrary hex value, conventionally containing the content of the memo.
      Returns:
      An Optional of type String containing the memo data.
    • memoFormat

      public abstract Optional<String> memoFormat()
      Hex value representing characters allowed in URLs. Conventionally containing information on how the memo is encoded.
      Returns:
      An Optional of type String containing the memo format.
    • memoType

      public abstract Optional<String> memoType()
      Hex value representing characters allowed in URLs. Conventionally, a unique relation that defines the format of this memo.
      Returns:
      An Optional of type String containing the memo type.