Package org.xrpl.xrpl4j.model.ledger
Class ImmutableSignerEntry
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableSignerEntry
- All Implemented Interfaces:
SignerEntry
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableSignerEntry
extends Object
implements SignerEntry
Immutable implementation of
SignerEntry.
Use the builder to create immutable instances:
ImmutableSignerEntry.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableSignerEntry. -
Method Summary
Modifier and TypeMethodDescriptionaccount()An XRP Ledger classicAddresswhose signature contributes to the multi-signature.static ImmutableSignerEntry.Builderbuilder()Creates a builder forImmutableSignerEntry.static ImmutableSignerEntrycopyOf(SignerEntry instance) Creates an immutable copy of aSignerEntryvalue.booleanThis instance is equal to all instances ofImmutableSignerEntrythat have equal attribute values.inthashCode()Computes a hash code from attributes:account,signerWeight.com.google.common.primitives.UnsignedIntegerThe weight of a signature from this signer.toString()Prints the immutable valueSignerEntrywith attribute values.final ImmutableSignerEntrywithAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.final ImmutableSignerEntrywithSignerWeight(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesignerWeightattribute.
-
Method Details
-
account
An XRP Ledger classicAddresswhose signature contributes to the multi-signature. It does not need to be a funded address in the ledger.- Specified by:
accountin interfaceSignerEntry- Returns:
- The
Addressof the signer.
-
signerWeight
public com.google.common.primitives.UnsignedInteger signerWeight()The weight of a signature from this signer. A multi-signature is only valid if the sum weight of the signatures provided meets or exceeds theSignerListObject.signerQuorum()value.- Specified by:
signerWeightin interfaceSignerEntry- Returns:
- An
UnsignedIntegerrepresenting the signer weight.
-
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
-
withSignerWeight
public final ImmutableSignerEntry withSignerWeight(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesignerWeightattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signerWeight- Returns:
- A modified copy of the
thisobject
-
equals
This instance is equal to all instances ofImmutableSignerEntrythat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:account,signerWeight. -
toString
Prints the immutable valueSignerEntrywith attribute values. -
copyOf
Creates an immutable copy of aSignerEntryvalue. 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 SignerEntry instance
-
builder
Creates a builder forImmutableSignerEntry.ImmutableSignerEntry.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.signerWeight(com.google.common.primitives.UnsignedInteger) // requiredsignerWeight.build();- Returns:
- A new ImmutableSignerEntry builder
-