Class ImmutableSetRegularKey
- All Implemented Interfaces:
SetRegularKey,Transaction
SetRegularKey.
Use the builder to create immutable instances:
ImmutableSetRegularKey.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableSetRegularKey. -
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionaccount()The uniqueAddressof the account that initiated this transaction.Hash value identifying another transaction.builder()Creates a builder forImmutableSetRegularKey.static ImmutableSetRegularKeycopyOf(SetRegularKey instance) Creates an immutable copy of aSetRegularKeyvalue.delegate()The delegate account that is sending the transaction on behalf of theaccount().booleanThis instance is equal to all instances ofImmutableSetRegularKeythat have equal attribute values.fee()TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.flags()Set ofTransactionFlagss for thisSetRegularKey, which only allows thetfFullyCanonicalSigflag, which is deprecated.inthashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,regularKey.Optional<com.google.common.primitives.UnsignedInteger> Highest ledger index this transaction can appear in.com.google.common.collect.ImmutableList<MemoWrapper> memos()Additional arbitrary information used to identify thisTransaction.AnAddressthat indicates the regular key pair to be assigned to the account.com.google.common.primitives.UnsignedIntegersequence()The sequence number of the account submitting theTransaction.com.google.common.collect.ImmutableList<SignerWrapper> signers()Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.ThePublicKeythat corresponds to the private key used to sign this transaction.Optional<com.google.common.primitives.UnsignedInteger> ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.Optional<com.google.common.primitives.UnsignedInteger> The sequence number of theTicketObjectto use in place of asequence()number.toString()Prints the immutable valueSetRegularKeywith attribute values.The signature that verifies this transaction as originating from the account it says it is from.The type of transaction.final ImmutableSetRegularKeywithAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.final ImmutableSetRegularKeywithAccountTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute.final ImmutableSetRegularKeywithAccountTransactionId(Hash256 value) Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.final ImmutableSetRegularKeywithDelegate(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for thedelegateattribute.final ImmutableSetRegularKeywithDelegate(Address value) Copy the current immutable object by setting a present value for the optionaldelegateattribute.final ImmutableSetRegularKeywithFee(XrpCurrencyAmount value) Copy the current immutable object by setting a value for thefeeattribute.final ImmutableSetRegularKeywithFlags(TransactionFlags value) Copy the current immutable object by setting a value for theflagsattribute.final ImmutableSetRegularKeywithLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.final ImmutableSetRegularKeywithLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute.final ImmutableSetRegularKeywithMemos(Iterable<? extends MemoWrapper> elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutableSetRegularKeywithMemos(MemoWrapper... elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutableSetRegularKeywithNetworkId(Optional<? extends NetworkId> optional) Copy the current immutable object by setting an optional value for thenetworkIdattribute.final ImmutableSetRegularKeywithNetworkId(NetworkId value) Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.final ImmutableSetRegularKeywithRegularKey(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for theregularKeyattribute.final ImmutableSetRegularKeywithRegularKey(Address value) Copy the current immutable object by setting a present value for the optionalregularKeyattribute.final ImmutableSetRegularKeywithSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute.final ImmutableSetRegularKeywithSigners(Iterable<? extends SignerWrapper> elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutableSetRegularKeywithSigners(SignerWrapper... elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutableSetRegularKeywithSigningPublicKey(PublicKey value) Copy the current immutable object by setting a value for thesigningPublicKeyattribute.final ImmutableSetRegularKeywithSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.final ImmutableSetRegularKeywithSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute.final ImmutableSetRegularKeywithTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.final ImmutableSetRegularKeywithTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute.final ImmutableSetRegularKeywithTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute.final ImmutableSetRegularKeyCopy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.final ImmutableSetRegularKeyCopy the current immutable object by setting a value for thetransactionTypeattribute.final ImmutableSetRegularKeywithUnknownFields(Map<String, ? extends Object> entries) Copy the current immutable object by replacing theunknownFieldsmap with the specified map.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
transactionFlags, validateDelegateNotSameAsAccount
-
Method Details
-
account
The uniqueAddressof the account that initiated this transaction.- Specified by:
accountin interfaceTransaction- Returns:
- The
Addressof the account submitting this transaction.
-
transactionType
The type of transaction.- Specified by:
transactionTypein interfaceTransaction- Returns:
- A
TransactionType.
-
fee
TheStringrepresentation 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:
feein interfaceTransaction- Returns:
- An
XrpCurrencyAmountrepresenting the transaction cost. - See Also:
-
sequence
public com.google.common.primitives.UnsignedInteger sequence()The sequence number of the account submitting theTransaction. ATransactionis 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:
sequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the sequence of the transaction. - See Also:
-
ticketSequence
The sequence number of theTicketObjectto use in place of asequence()number. If this is provided,sequence()must be 0. Cannot be used withaccountTransactionId().- Specified by:
ticketSequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the ticket sequence of the transaction.
-
accountTransactionId
Hash value identifying another transaction. If provided, thisTransactionis only valid if the sending account's previously-sent transaction matches the provided hash.- Specified by:
accountTransactionIdin interfaceTransaction- Returns:
- An
Optionalof typeHash256containing the account transaction ID.
-
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:
lastLedgerSequencein interfaceTransaction- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the last ledger sequence.
-
memos
Additional arbitrary information used to identify thisTransaction.- Specified by:
memosin interfaceTransaction- Returns:
- A
ListofMemoWrappers.
-
signers
Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.- Specified by:
signersin interfaceTransaction- Returns:
- A
ListofSignerWrappers.
-
sourceTag
ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.- Specified by:
sourceTagin interfaceTransaction- Returns:
- An
OptionalUnsignedIntegerrepresenting the source account's tag.
-
signingPublicKey
ThePublicKeythat corresponds to the private key used to sign this transaction. If an empty string, iePublicKey.MULTI_SIGN_PUBLIC_KEY, indicates a multi-signature is present in theTransaction.signers()field instead.- Specified by:
signingPublicKeyin interfaceTransaction- Returns:
- A
PublicKeycontaining the public key of the account submitting the transaction, orPublicKey.MULTI_SIGN_PUBLIC_KEYif the transaction is multi-signed.
-
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:
transactionSignaturein interfaceTransaction- Returns:
- An
OptionalStringcontaining the transaction signature.
-
networkId
- Specified by:
networkIdin interfaceTransaction- Returns:
- The value of the
networkIdattribute
-
delegate
The delegate account that is sending the transaction on behalf of theaccount().The way the
Delegatefield works is somewhat akin toRegularKey. Theaccount()field is the delegating account, theDelegatefield is the delegate, and thesigningPublicKey()andtransactionSignature()are based on the delegate's keys.If a
Delegatehas multisign enabled, they can also use that multisign setup on their delegated transactions.The delegate will pay the fees on the transaction, to prevent a delegate from draining an account's XRP via fees. Only the
account()'s sequence number is incremented, not theDelegate's.This field is part of the Permission Delegation feature (XLS-75).
- Specified by:
delegatein interfaceTransaction- Returns:
- An
OptionalAddressof the delegate account. - See Also:
-
unknownFields
- Specified by:
unknownFieldsin interfaceTransaction- Returns:
- The value of the
unknownFieldsattribute
-
flags
Set ofTransactionFlagss for thisSetRegularKey, which only allows thetfFullyCanonicalSigflag, which is deprecated.The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.
- Specified by:
flagsin interfaceSetRegularKey- Returns:
- Always
TransactionFlags.EMPTY.
-
regularKey
AnAddressthat indicates the regular key pair to be assigned to the account. If omitted, removes any existing regular key pair from the account. Must not match the master key pair for the address.- Specified by:
regularKeyin interfaceSetRegularKey- Returns:
- The
OptionalAddressindicating the regular key pair to use.
-
withAccount
Copy the current immutable object by setting a value for theaccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for account- Returns:
- A modified copy of the
thisobject
-
withTransactionType
Copy the current immutable object by setting a value for thetransactionTypeattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for transactionType- Returns:
- A modified copy of the
thisobject
-
withFee
Copy the current immutable object by setting a value for thefeeattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for fee- Returns:
- A modified copy of the
thisobject
-
withSequence
public final ImmutableSetRegularKey withSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for sequence- Returns:
- A modified copy of the
thisobject
-
withTicketSequence
public final ImmutableSetRegularKey withTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.- Parameters:
value- The value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withTicketSequence
public final ImmutableSetRegularKey withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.- Parameters:
value- The value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableSetRegularKey withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.- Parameters:
value- The value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutableSetRegularKey withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of memos elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of signers elements to set- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutableSetRegularKey withSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.- Parameters:
value- The value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutableSetRegularKey withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSigningPublicKey
Copy the current immutable object by setting a value for thesigningPublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signingPublicKey- Returns:
- A modified copy of the
thisobject
-
withTransactionSignature
Copy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.- Parameters:
value- The value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withTransactionSignature
public final ImmutableSetRegularKey withTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.- Parameters:
value- The value for networkId- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting an optional value for thenetworkIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for networkId- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting a present value for the optionaldelegateattribute.- Parameters:
value- The value for delegate- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting an optional value for thedelegateattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for delegate- Returns:
- A modified copy of
thisobject
-
withUnknownFields
Copy the current immutable object by replacing theunknownFieldsmap with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
entries- The entries to be added to the unknownFields map- Returns:
- A modified copy of
thisobject
-
withFlags
Copy the current immutable object by setting a value for theflagsattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for flags- Returns:
- A modified copy of the
thisobject
-
withRegularKey
Copy the current immutable object by setting a present value for the optionalregularKeyattribute.- Parameters:
value- The value for regularKey- Returns:
- A modified copy of
thisobject
-
withRegularKey
Copy the current immutable object by setting an optional value for theregularKeyattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for regularKey- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutableSetRegularKeythat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,regularKey. -
toString
Prints the immutable valueSetRegularKeywith attribute values. -
copyOf
Creates an immutable copy of aSetRegularKeyvalue. 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 SetRegularKey instance
-
builder
Creates a builder forImmutableSetRegularKey.ImmutableSetRegularKey.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.transactionType(org.xrpl.xrpl4j.model.transactions.TransactionType) // optionaltransactionType.fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredfee.sequence(com.google.common.primitives.UnsignedInteger) // optionalsequence.ticketSequence(com.google.common.primitives.UnsignedInteger) // optionalticketSequence.accountTransactionId(Hash256) // optionalaccountTransactionId.lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optionallastLedgerSequence.addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) //memoselements .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) //signerselements .sourceTag(com.google.common.primitives.UnsignedInteger) // optionalsourceTag.signingPublicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // optionalsigningPublicKey.transactionSignature(org.xrpl.xrpl4j.crypto.signing.Signature) // optionaltransactionSignature.networkId(NetworkId) // optionalnetworkId.delegate(Address) // optionaldelegate.putUnknownFields|putAllUnknownFields(String => Object) //unknownFieldsmappings .flags(org.xrpl.xrpl4j.model.flags.TransactionFlags) // optionalflags.regularKey(Address) // optionalregularKey.build();- Returns:
- A new ImmutableSetRegularKey builder
-