Package org.xrpl.xrpl4j.model.client.accounts

Class ImmutableAccountInfoRequestParams

java.lang.Object

org.xrpl.xrpl4j.model.client.accounts.ImmutableAccountInfoRequestParams

All Implemented Interfaces:

AccountInfoRequestParams, XrplRequestParams

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableAccountInfoRequestParams
extends Object
implements AccountInfoRequestParams

Immutable implementation of AccountInfoRequestParams.

Use the builder to create immutable instances: ImmutableAccountInfoRequestParams.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableAccountInfoRequestParams.Builder	Builds instances of type ImmutableAccountInfoRequestParams.

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique Address for the account.
static ImmutableAccountInfoRequestParams.Builder	builder()	Creates a builder for ImmutableAccountInfoRequestParams.
static ImmutableAccountInfoRequestParams	copyOf(AccountInfoRequestParams instance)	Creates an immutable copy of a AccountInfoRequestParams value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAccountInfoRequestParams that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: account, ledgerSpecifier, strict, queue, signerLists.
Optional<Hash256>	ledgerHash()	Deprecated. Ledger hash should be specified in ledgerSpecifier().
LedgerIndex	ledgerIndex()	Deprecated. Ledger index and any shortcut values should be specified in ledgerSpecifier().
LedgerSpecifier	ledgerSpecifier()	Specifies the ledger version to request.
boolean	queue()	If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account.
boolean	signerLists()	If true, and the MultiSign amendment is enabled, also returns any SignerListObjects associated with this account.
boolean	strict()	A boolean indicating if the account() field only accepts a public key or XRP Ledger Address.
String	toString()	Prints the immutable value AccountInfoRequestParams with attribute values.
ImmutableAccountInfoRequestParams	withAccount(Address value)	Copy the current immutable object by setting a value for the account attribute.
ImmutableAccountInfoRequestParams	withLedgerHash(Optional<? extends Hash256> optional)	Deprecated.
ImmutableAccountInfoRequestParams	withLedgerHash(Hash256 value)	Deprecated.
ImmutableAccountInfoRequestParams	withLedgerIndex(LedgerIndex value)	Deprecated.
ImmutableAccountInfoRequestParams	withLedgerSpecifier(LedgerSpecifier value)	Copy the current immutable object by setting a value for the ledgerSpecifier attribute.
ImmutableAccountInfoRequestParams	withQueue(boolean value)	Copy the current immutable object by setting a value for the queue attribute.
ImmutableAccountInfoRequestParams	withSignerLists(boolean value)	Copy the current immutable object by setting a value for the signerLists attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

account

public Address account()

A unique Address for the account.

Specified by:

account in interface AccountInfoRequestParams

Returns:

The Address of the account.

ledgerHash

@Deprecated
public Optional<Hash256> ledgerHash()

Deprecated.

Ledger hash should be specified in ledgerSpecifier().

A 20-byte hex string for the ledger version to use.

Specified by:

ledgerHash in interface AccountInfoRequestParams

Returns:

An optionally-present Hash256.

ledgerIndex

@Deprecated
@Nullable
public LedgerIndex ledgerIndex()

Deprecated.

Ledger index and any shortcut values should be specified in ledgerSpecifier().

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

Specified by:

ledgerIndex in interface AccountInfoRequestParams

Returns:

A LedgerIndex. Defaults to LedgerIndex.CURRENT.

ledgerSpecifier

public LedgerSpecifier ledgerSpecifier()

Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index, or a shortcut value.

Specified by:

ledgerSpecifier in interface AccountInfoRequestParams

Returns:

A LedgerSpecifier specifying the ledger version to request.

strict

public boolean strict()

A boolean indicating if the account() field only accepts a public key or XRP Ledger Address. Always true, as account() is always an Address.

Specified by:

strict in interface AccountInfoRequestParams

Returns:

true if the account field only accepts a public key or XRP Ledger address, otherwise false. Defaults to true.

queue

public boolean queue()

If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger.

Specified by:

queue in interface AccountInfoRequestParams

Returns:

true if queue transactions should be returned in the response, false if not. Defaults to false.

signerLists

public boolean signerLists()

If true, and the MultiSign amendment is enabled, also returns any SignerListObjects associated with this account.

Specified by:

signerLists in interface AccountInfoRequestParams

Returns:

true if signer lists should be returns, false if not. Defaults to true.

withAccount

public final ImmutableAccountInfoRequestParams 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

withLedgerHash

@Deprecated
public final ImmutableAccountInfoRequestParams withLedgerHash(Hash256 value)

Deprecated.

Copy the current immutable object by setting a present value for the optional ledgerHash attribute.

Parameters:

value - The value for ledgerHash

Returns:

A modified copy of this object

withLedgerHash

@Deprecated
public final ImmutableAccountInfoRequestParams withLedgerHash(Optional<? extends Hash256> optional)

Deprecated.

Copy the current immutable object by setting an optional value for the ledgerHash 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 ledgerHash

Returns:

A modified copy of this object

withLedgerIndex

@Deprecated
public final ImmutableAccountInfoRequestParams withLedgerIndex(@Nullable
                                                               LedgerIndex value)

Deprecated.

Copy the current immutable object by setting a value for the ledgerIndex attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for ledgerIndex (can be null)

Returns:

A modified copy of the this object

withLedgerSpecifier

public final ImmutableAccountInfoRequestParams withLedgerSpecifier(LedgerSpecifier value)

Copy the current immutable object by setting a value for the ledgerSpecifier attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for ledgerSpecifier

Returns:

A modified copy of the this object

withQueue

public final ImmutableAccountInfoRequestParams withQueue(boolean value)

Copy the current immutable object by setting a value for the queue attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for queue

Returns:

A modified copy of the this object

withSignerLists

public final ImmutableAccountInfoRequestParams withSignerLists(boolean value)

Copy the current immutable object by setting a value for the signerLists attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for signerLists

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableAccountInfoRequestParams 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, ledgerSpecifier, strict, queue, signerLists.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AccountInfoRequestParams with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableAccountInfoRequestParams copyOf(AccountInfoRequestParams instance)

Creates an immutable copy of a AccountInfoRequestParams 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 AccountInfoRequestParams instance

builder

public static ImmutableAccountInfoRequestParams.Builder builder()

Creates a builder for ImmutableAccountInfoRequestParams.

 ImmutableAccountInfoRequestParams.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .ledgerHash(org.xrpl.xrpl4j.model.transactions.Hash256) // optional ledgerHash
    .ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex | null) // nullable ledgerIndex
    .ledgerSpecifier(org.xrpl.xrpl4j.model.client.common.LedgerSpecifier) // optional ledgerSpecifier
    .queue(boolean) // optional queue
    .signerLists(boolean) // optional signerLists
    .build();
 

Returns:

A new ImmutableAccountInfoRequestParams builder