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

Class ImmutableAccountChannelsRequestParams

java.lang.Object

org.xrpl.xrpl4j.model.client.accounts.ImmutableAccountChannelsRequestParams

All Implemented Interfaces:

AccountChannelsRequestParams, XrplRequestParams

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

Immutable implementation of AccountChannelsRequestParams.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Address	account()	The unique Address for the account.
static ImmutableAccountChannelsRequestParams.Builder	builder()	Creates a builder for ImmutableAccountChannelsRequestParams.
static ImmutableAccountChannelsRequestParams	copyOf(AccountChannelsRequestParams instance)	Creates an immutable copy of a AccountChannelsRequestParams value.
Optional<Address>	destinationAccount()	The unique Address for the destination account.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAccountChannelsRequestParams that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: account, destinationAccount, ledgerSpecifier, limit, marker.
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.
Optional<com.google.common.primitives.UnsignedInteger>	limit()	Limit the number of transactions to retrieve.
Optional<Marker>	marker()	Value from a previous paginated response.
String	toString()	Prints the immutable value AccountChannelsRequestParams with attribute values.
ImmutableAccountChannelsRequestParams	withAccount(Address value)	Copy the current immutable object by setting a value for the account attribute.
ImmutableAccountChannelsRequestParams	withDestinationAccount(Optional<? extends Address> optional)	Copy the current immutable object by setting an optional value for the destinationAccount attribute.
ImmutableAccountChannelsRequestParams	withDestinationAccount(Address value)	Copy the current immutable object by setting a present value for the optional destinationAccount attribute.
ImmutableAccountChannelsRequestParams	withLedgerHash(Optional<? extends Hash256> optional)	Deprecated.
ImmutableAccountChannelsRequestParams	withLedgerHash(Hash256 value)	Deprecated.
ImmutableAccountChannelsRequestParams	withLedgerIndex(LedgerIndex value)	Deprecated.
ImmutableAccountChannelsRequestParams	withLedgerSpecifier(LedgerSpecifier value)	Copy the current immutable object by setting a value for the ledgerSpecifier attribute.
ImmutableAccountChannelsRequestParams	withLimit(com.google.common.primitives.UnsignedInteger value)	Copy the current immutable object by setting a present value for the optional limit attribute.
ImmutableAccountChannelsRequestParams	withLimit(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)	Copy the current immutable object by setting an optional value for the limit attribute.
ImmutableAccountChannelsRequestParams	withMarker(Optional<? extends Marker> optional)	Copy the current immutable object by setting an optional value for the marker attribute.
ImmutableAccountChannelsRequestParams	withMarker(Marker value)	Copy the current immutable object by setting a present value for the optional marker attribute.

Methods inherited from class java.lang.Object

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

Method Detail

account

public Address account()

The unique Address for the account. The request returns channels where this account is the channel's owner/source.

Specified by:

account in interface AccountChannelsRequestParams

Returns:

The Address for the account.

destinationAccount

public Optional<Address> destinationAccount()

The unique Address for the destination account. If provided, the response results are filtered by channels whose destination is this account.

Specified by:

destinationAccount in interface AccountChannelsRequestParams

Returns:

The optionally present Address of the destination 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 AccountChannelsRequestParams

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 AccountChannelsRequestParams

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 AccountChannelsRequestParams

Returns:

A LedgerSpecifier specifying the ledger version to request.

limit

public Optional<com.google.common.primitives.UnsignedInteger> limit()

Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The default is 200.

Specified by:

limit in interface AccountChannelsRequestParams

Returns:

An optionally-present UnsignedInteger.

marker

public Optional<Marker> marker()

Value from a previous paginated response. Resume retrieving data where that response left off.

Specified by:

marker in interface AccountChannelsRequestParams

Returns:

An optionally-present String.

withAccount

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

withDestinationAccount

public final ImmutableAccountChannelsRequestParams withDestinationAccount(Address value)

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

Parameters:

value - The value for destinationAccount

Returns:

A modified copy of this object

withDestinationAccount

public final ImmutableAccountChannelsRequestParams withDestinationAccount(Optional<? extends Address> optional)

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

Returns:

A modified copy of this object

withLedgerHash

@Deprecated
public final ImmutableAccountChannelsRequestParams 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 ImmutableAccountChannelsRequestParams 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 ImmutableAccountChannelsRequestParams 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 ImmutableAccountChannelsRequestParams 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

withLimit

public final ImmutableAccountChannelsRequestParams withLimit(com.google.common.primitives.UnsignedInteger value)

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

Parameters:

value - The value for limit

Returns:

A modified copy of this object

withLimit

public final ImmutableAccountChannelsRequestParams withLimit(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)

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

Returns:

A modified copy of this object

withMarker

public final ImmutableAccountChannelsRequestParams withMarker(Marker value)

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

Parameters:

value - The value for marker

Returns:

A modified copy of this object

withMarker

public final ImmutableAccountChannelsRequestParams withMarker(Optional<? extends Marker> optional)

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

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableAccountChannelsRequestParams 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, destinationAccount, ledgerSpecifier, limit, marker.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AccountChannelsRequestParams with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableAccountChannelsRequestParams copyOf(AccountChannelsRequestParams instance)

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

builder

public static ImmutableAccountChannelsRequestParams.Builder builder()

Creates a builder for ImmutableAccountChannelsRequestParams.

 ImmutableAccountChannelsRequestParams.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .destinationAccount(org.xrpl.xrpl4j.model.transactions.Address) // optional destinationAccount
    .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
    .limit(com.google.common.primitives.UnsignedInteger) // optional limit
    .marker(org.xrpl.xrpl4j.model.transactions.Marker) // optional marker
    .build();
 

Returns:

A new ImmutableAccountChannelsRequestParams builder