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

Class ImmutableAccountCurrenciesRequestParams

java.lang.Object

org.xrpl.xrpl4j.model.client.accounts.ImmutableAccountCurrenciesRequestParams

All Implemented Interfaces:

AccountCurrenciesRequestParams, XrplRequestParams

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

Immutable implementation of AccountCurrenciesRequestParams.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique identifier for the account, most commonly the account's Address.
static ImmutableAccountCurrenciesRequestParams.Builder	builder()	Creates a builder for ImmutableAccountCurrenciesRequestParams.
static ImmutableAccountCurrenciesRequestParams	copyOf(AccountCurrenciesRequestParams instance)	Creates an immutable copy of a AccountCurrenciesRequestParams value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAccountCurrenciesRequestParams that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: account, ledgerSpecifier, strict.
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	strict()	A boolean indicating if the account() field only accepts a public key or XRP Ledger Address.
String	toString()	Prints the immutable value AccountCurrenciesRequestParams with attribute values.
ImmutableAccountCurrenciesRequestParams	withAccount(Address value)	Copy the current immutable object by setting a value for the account attribute.
ImmutableAccountCurrenciesRequestParams	withLedgerHash(Optional<? extends Hash256> optional)	Deprecated.
ImmutableAccountCurrenciesRequestParams	withLedgerHash(Hash256 value)	Deprecated.
ImmutableAccountCurrenciesRequestParams	withLedgerIndex(LedgerIndex value)	Deprecated.
ImmutableAccountCurrenciesRequestParams	withLedgerSpecifier(LedgerSpecifier value)	Copy the current immutable object by setting a value for the ledgerSpecifier attribute.

Methods inherited from class java.lang.Object

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

Method Detail

account

public Address account()

A unique identifier for the account, most commonly the account's Address.

Specified by:

account in interface AccountCurrenciesRequestParams

Returns:

The Address for 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 AccountCurrenciesRequestParams

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 AccountCurrenciesRequestParams

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 AccountCurrenciesRequestParams

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 AccountCurrenciesRequestParams

Returns:

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

withAccount

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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableAccountCurrenciesRequestParams 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.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AccountCurrenciesRequestParams with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableAccountCurrenciesRequestParams copyOf(AccountCurrenciesRequestParams instance)

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

builder

public static ImmutableAccountCurrenciesRequestParams.Builder builder()

Creates a builder for ImmutableAccountCurrenciesRequestParams.

 ImmutableAccountCurrenciesRequestParams.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
    .build();
 

Returns:

A new ImmutableAccountCurrenciesRequestParams builder