Package org.xrpl.xrpl4j.model.transactions

Class ImmutableDepositPreAuth

    • Method Detail

      • account

        public Address account()
        The unique Address of the account that initiated this transaction.
        Specified by:
        account in interface Transaction
        Returns:
        The Address of the account submitting this transaction.

      • fee

        public XrpCurrencyAmount fee()
        The String representation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.

        This field is auto-fillable

        Specified by:
        fee in interface Transaction
        Returns:
        An XrpCurrencyAmount representing the transaction cost.
        See Also:
        "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"

      • sequence

        public com.google.common.primitives.UnsignedInteger sequence()
        The sequence number of the account submitting the Transaction. A Transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account.

        This field is auto-fillable

        Specified by:
        sequence in interface Transaction
        Returns:
        An UnsignedInteger representing the sequence of the transaction.
        See Also:
        "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"

      • accountTransactionId

        public Optional<Hash256> accountTransactionId()
        Hash value identifying another transaction. If provided, this Transaction is only valid if the sending account's previously-sent transaction matches the provided hash.
        Specified by:
        accountTransactionId in interface Transaction
        Returns:
        An Optional of type Hash256 containing the account transaction ID.

      • lastLedgerSequence

        public Optional<com.google.common.primitives.UnsignedInteger> lastLedgerSequence()
        Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.
        Specified by:
        lastLedgerSequence in interface Transaction
        Returns:
        An Optional of type UnsignedInteger representing the last ledger sequence.

      • sourceTag

        public Optional<com.google.common.primitives.UnsignedInteger> sourceTag()
        Arbitrary UnsignedInteger used to identify the reason for this Transaction, or a sender on whose behalf this Transaction is made.
        Specified by:
        sourceTag in interface Transaction
        Returns:
        An Optional UnsignedInteger representing the source account's tag.

      • signingPublicKey

        public Optional<String> signingPublicKey()
        Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Transaction.signers() field instead.

        This field is automatically added when signing this Transaction.

        Specified by:
        signingPublicKey in interface Transaction
        Returns:
        An Optional String containing the public key of the account submitting the transaction.

      • transactionSignature

        public Optional<String> transactionSignature()
        The signature that verifies this transaction as originating from the account it says it is from.

        This field is automatically added when signing this Transaction.

        Specified by:
        transactionSignature in interface Transaction
        Returns:
        An Optional String containing the transaction signature.

      • closeDate

        @Deprecated
public Optional<com.google.common.primitives.UnsignedLong> closeDate()
        Deprecated.
        This field will be removed in favor of TransactionResult.closeDate();
        The approximate close time (using Ripple Epoch) of the ledger containing this transaction. This is an undocumented field.
        Specified by:
        closeDate in interface Transaction
        Returns:
        An optionally-present UnsignedLong.

      • withAccount

        public final ImmutableDepositPreAuth withAccount​(Address value)
        Copy the current immutable object by setting a value for the account attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for account
        Returns:
        A modified copy of the this object

      • withFee

        public final ImmutableDepositPreAuth withFee​(XrpCurrencyAmount value)
        Copy the current immutable object by setting a value for the fee attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for fee
        Returns:
        A modified copy of the this object

      • withSequence

        public final ImmutableDepositPreAuth withSequence​(com.google.common.primitives.UnsignedInteger value)
        Copy the current immutable object by setting a value for the sequence attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for sequence
        Returns:
        A modified copy of the this object

      • withAccountTransactionId

        public final ImmutableDepositPreAuth withAccountTransactionId​(Hash256 value)
        Copy the current immutable object by setting a present value for the optional accountTransactionId attribute.
        Parameters:
        value - The value for accountTransactionId
        Returns:
        A modified copy of this object

      • withAccountTransactionId

        public final ImmutableDepositPreAuth withAccountTransactionId​(Optional<? extends Hash256> optional)
        Copy the current immutable object by setting an optional value for the accountTransactionId attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for accountTransactionId
        Returns:
        A modified copy of this object

      • withLastLedgerSequence

        public final ImmutableDepositPreAuth withLastLedgerSequence​(com.google.common.primitives.UnsignedInteger value)
        Copy the current immutable object by setting a present value for the optional lastLedgerSequence attribute.
        Parameters:
        value - The value for lastLedgerSequence
        Returns:
        A modified copy of this object

      • withLastLedgerSequence

        public final ImmutableDepositPreAuth withLastLedgerSequence​(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
        Copy the current immutable object by setting an optional value for the lastLedgerSequence attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for lastLedgerSequence
        Returns:
        A modified copy of this object

      • withMemos

        public final ImmutableDepositPreAuth withMemos​(MemoWrapper... elements)
        Copy the current immutable object with elements that replace the content of memos.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withMemos

        public final ImmutableDepositPreAuth withMemos​(Iterable<? extends MemoWrapper> elements)
        Copy the current immutable object with elements that replace the content of memos. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of memos elements to set
        Returns:
        A modified copy of this object

      • withSigners

        public final ImmutableDepositPreAuth withSigners​(SignerWrapper... elements)
        Copy the current immutable object with elements that replace the content of signers.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withSigners

        public final ImmutableDepositPreAuth withSigners​(Iterable<? extends SignerWrapper> elements)
        Copy the current immutable object with elements that replace the content of signers. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of signers elements to set
        Returns:
        A modified copy of this object

      • withSourceTag

        public final ImmutableDepositPreAuth withSourceTag​(com.google.common.primitives.UnsignedInteger value)
        Copy the current immutable object by setting a present value for the optional sourceTag attribute.
        Parameters:
        value - The value for sourceTag
        Returns:
        A modified copy of this object

      • withSourceTag

        public final ImmutableDepositPreAuth withSourceTag​(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
        Copy the current immutable object by setting an optional value for the sourceTag attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for sourceTag
        Returns:
        A modified copy of this object

      • withSigningPublicKey

        public final ImmutableDepositPreAuth withSigningPublicKey​(String value)
        Copy the current immutable object by setting a present value for the optional signingPublicKey attribute.
        Parameters:
        value - The value for signingPublicKey
        Returns:
        A modified copy of this object

      • withSigningPublicKey

        public final ImmutableDepositPreAuth withSigningPublicKey​(Optional<String> optional)
        Copy the current immutable object by setting an optional value for the signingPublicKey attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for signingPublicKey
        Returns:
        A modified copy of this object

      • withTransactionSignature

        public final ImmutableDepositPreAuth withTransactionSignature​(String value)
        Copy the current immutable object by setting a present value for the optional transactionSignature attribute.
        Parameters:
        value - The value for transactionSignature
        Returns:
        A modified copy of this object

      • withTransactionSignature

        public final ImmutableDepositPreAuth withTransactionSignature​(Optional<String> optional)
        Copy the current immutable object by setting an optional value for the transactionSignature attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for transactionSignature
        Returns:
        A modified copy of this object

      • withCloseDate

        @Deprecated
public final ImmutableDepositPreAuth withCloseDate​(com.google.common.primitives.UnsignedLong value)
        Deprecated.
        Copy the current immutable object by setting a present value for the optional closeDate attribute.
        Parameters:
        value - The value for closeDate
        Returns:
        A modified copy of this object

      • withCloseDate

        @Deprecated
public final ImmutableDepositPreAuth withCloseDate​(Optional<? extends com.google.common.primitives.UnsignedLong> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the closeDate attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for closeDate
        Returns:
        A modified copy of this object

      • withHash

        @Deprecated
public final ImmutableDepositPreAuth withHash​(Hash256 value)
        Deprecated.
        Copy the current immutable object by setting a present value for the optional hash attribute.
        Parameters:
        value - The value for hash
        Returns:
        A modified copy of this object

      • withHash

        @Deprecated
public final ImmutableDepositPreAuth withHash​(Optional<? extends Hash256> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the hash attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for hash
        Returns:
        A modified copy of this object

      • withLedgerIndex

        @Deprecated
public final ImmutableDepositPreAuth withLedgerIndex​(LedgerIndex value)
        Deprecated.
        Copy the current immutable object by setting a present value for the optional ledgerIndex attribute.
        Parameters:
        value - The value for ledgerIndex
        Returns:
        A modified copy of this object

      • withLedgerIndex

        @Deprecated
public final ImmutableDepositPreAuth withLedgerIndex​(Optional<? extends LedgerIndex> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the ledgerIndex attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for ledgerIndex
        Returns:
        A modified copy of this object

      • withAuthorize

        public final ImmutableDepositPreAuth withAuthorize​(Address value)
        Copy the current immutable object by setting a present value for the optional authorize attribute.
        Parameters:
        value - The value for authorize
        Returns:
        A modified copy of this object

      • withAuthorize

        public final ImmutableDepositPreAuth withAuthorize​(Optional<? extends Address> optional)
        Copy the current immutable object by setting an optional value for the authorize attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for authorize
        Returns:
        A modified copy of this object

      • withUnauthorize

        public final ImmutableDepositPreAuth withUnauthorize​(Address value)
        Copy the current immutable object by setting a present value for the optional unauthorize attribute.
        Parameters:
        value - The value for unauthorize
        Returns:
        A modified copy of this object

      • withUnauthorize

        public final ImmutableDepositPreAuth withUnauthorize​(Optional<? extends Address> optional)
        Copy the current immutable object by setting an optional value for the unauthorize attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for unauthorize
        Returns:
        A modified copy of this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableDepositPreAuth that have equal attribute values.
        Overrides:
        equals in class Object
        Returns:
        true if this is equal to another instance

      • hashCode

        public int hashCode()
        Computes a hash code from attributes: account, fee, sequence, accountTransactionId, lastLedgerSequence, memos, signers, sourceTag, signingPublicKey, transactionSignature, closeDate, hash, ledgerIndex, flags, authorize, unauthorize.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

        public String toString()
        Prints the immutable value DepositPreAuth with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value

      • copyOf

        public static ImmutableDepositPreAuth copyOf​(DepositPreAuth instance)
        Creates an immutable copy of a DepositPreAuth value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
        Parameters:
        instance - The instance to copy
        Returns:
        A copied immutable DepositPreAuth instance

      • builder

        public static ImmutableDepositPreAuth.Builder builder()
        Creates a builder for ImmutableDepositPreAuth. 
         ImmutableDepositPreAuth.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // required fee
    .sequence(com.google.common.primitives.UnsignedInteger) // required sequence
    .accountTransactionId(Hash256) // optional accountTransactionId
    .lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optional lastLedgerSequence
    .addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) // memos elements
    .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) // signers elements
    .sourceTag(com.google.common.primitives.UnsignedInteger) // optional sourceTag
    .signingPublicKey(String) // optional signingPublicKey
    .transactionSignature(String) // optional transactionSignature
    .closeDate(com.google.common.primitives.UnsignedLong) // optional closeDate
    .hash(Hash256) // optional hash
    .ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optional ledgerIndex
    .authorize(Address) // optional authorize
    .unauthorize(Address) // optional unauthorize
    .build();
        Returns:
        A new ImmutableDepositPreAuth builder