Package org.xrpl.xrpl4j.model.ledger
Class ImmutableNfTokenPageObject
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableNfTokenPageObject
- All Implemented Interfaces:
LedgerObject,NfTokenPageObject
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableNfTokenPageObject
extends Object
implements NfTokenPageObject
Immutable implementation of
NfTokenPageObject.
Use the builder to create immutable instances:
ImmutableNfTokenPageObject.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableNfTokenPageObject.Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Creates a builder forImmutableNfTokenPageObject.static ImmutableNfTokenPageObjectcopyOf(NfTokenPageObject instance) Creates an immutable copy of aNfTokenPageObjectvalue.booleanThis instance is equal to all instances ofImmutableNfTokenPageObjectthat have equal attribute values.inthashCode()Computes a hash code from attributes:ledgerEntryType,nfTokens,nextPageMin,previousPageMin,previousTransactionId,previousTransactionLedgerSequence,index.index()The unique ID of thisNfTokenPageObjectledger object.The type of ledger object, which will always be "NFTokenPage" in this case.The locator of the next page, if any.com.google.common.collect.ImmutableList<NfTokenWrapper> nfTokens()The collection of NFToken objects contained in this NFTokenPage object.The locator of the previous page, if any.Identifies the transaction ID of the transaction that most recently modified this NFTokenPage object.The sequence of the ledger that contains the transaction that most recently modified this NFTokenPage object.toString()Prints the immutable valueNfTokenPageObjectwith attribute values.Copy the current immutable object by setting a value for theindexattribute.withNextPageMin(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for thenextPageMinattribute.withNextPageMin(Hash256 value) Copy the current immutable object by setting a present value for the optionalnextPageMinattribute.withNfTokens(Iterable<? extends NfTokenWrapper> elements) Copy the current immutable object with elements that replace the content ofnfTokens.withNfTokens(NfTokenWrapper... elements) Copy the current immutable object with elements that replace the content ofnfTokens.withPreviousPageMin(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for thepreviousPageMinattribute.withPreviousPageMin(Hash256 value) Copy the current immutable object by setting a present value for the optionalpreviousPageMinattribute.withPreviousTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for thepreviousTransactionIdattribute.withPreviousTransactionId(Hash256 value) Copy the current immutable object by setting a present value for the optionalpreviousTransactionIdattribute.withPreviousTransactionLedgerSequence(Optional<? extends LedgerIndex> optional) Copy the current immutable object by setting an optional value for thepreviousTransactionLedgerSequenceattribute.Copy the current immutable object by setting a present value for the optionalpreviousTransactionLedgerSequenceattribute.
-
Method Details
-
ledgerEntryType
The type of ledger object, which will always be "NFTokenPage" in this case.- Specified by:
ledgerEntryTypein interfaceNfTokenPageObject- Returns:
- Always returns
LedgerObject.LedgerEntryType.ACCOUNT_ROOT.
-
nfTokens
The collection of NFToken objects contained in this NFTokenPage object. This specification places an upper bound of 32 NFToken objects per page. Objects are sorted from low to high with the NFTokenID used as the sorting parameter.- Specified by:
nfTokensin interfaceNfTokenPageObject- Returns:
- A
ListofNfTokens.
-
nextPageMin
The locator of the next page, if any.- Specified by:
nextPageMinin interfaceNfTokenPageObject- Returns:
- A
Hash256containing the ID of the next page, orOptional.empty()if there is no next page.
-
previousPageMin
The locator of the previous page, if any.- Specified by:
previousPageMinin interfaceNfTokenPageObject- Returns:
- A
Hash256containing the ID of the previous page, orOptional.empty()if there is no previous page.
-
previousTransactionId
Identifies the transaction ID of the transaction that most recently modified this NFTokenPage object.- Specified by:
previousTransactionIdin interfaceNfTokenPageObject- Returns:
- An optionally-present
Hash256.
-
previousTransactionLedgerSequence
The sequence of the ledger that contains the transaction that most recently modified this NFTokenPage object.- Specified by:
previousTransactionLedgerSequencein interfaceNfTokenPageObject- Returns:
- A
LedgerIndex.
-
index
The unique ID of thisNfTokenPageObjectledger object.- Specified by:
indexin interfaceNfTokenPageObject- Returns:
- A
Hash256. - See Also:
-
withNfTokens
Copy the current immutable object with elements that replace the content ofnfTokens.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withNfTokens
Copy the current immutable object with elements that replace the content ofnfTokens. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of nfTokens elements to set- Returns:
- A modified copy of
thisobject
-
withNextPageMin
Copy the current immutable object by setting a present value for the optionalnextPageMinattribute.- Parameters:
value- The value for nextPageMin- Returns:
- A modified copy of
thisobject
-
withNextPageMin
Copy the current immutable object by setting an optional value for thenextPageMinattribute. 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 nextPageMin- Returns:
- A modified copy of
thisobject
-
withPreviousPageMin
Copy the current immutable object by setting a present value for the optionalpreviousPageMinattribute.- Parameters:
value- The value for previousPageMin- Returns:
- A modified copy of
thisobject
-
withPreviousPageMin
Copy the current immutable object by setting an optional value for thepreviousPageMinattribute. 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 previousPageMin- Returns:
- A modified copy of
thisobject
-
withPreviousTransactionId
Copy the current immutable object by setting a present value for the optionalpreviousTransactionIdattribute.- Parameters:
value- The value for previousTransactionId- Returns:
- A modified copy of
thisobject
-
withPreviousTransactionId
public final ImmutableNfTokenPageObject withPreviousTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for thepreviousTransactionIdattribute. 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 previousTransactionId- Returns:
- A modified copy of
thisobject
-
withPreviousTransactionLedgerSequence
Copy the current immutable object by setting a present value for the optionalpreviousTransactionLedgerSequenceattribute.- Parameters:
value- The value for previousTransactionLedgerSequence- Returns:
- A modified copy of
thisobject
-
withPreviousTransactionLedgerSequence
public final ImmutableNfTokenPageObject withPreviousTransactionLedgerSequence(Optional<? extends LedgerIndex> optional) Copy the current immutable object by setting an optional value for thepreviousTransactionLedgerSequenceattribute. 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 previousTransactionLedgerSequence- Returns:
- A modified copy of
thisobject
-
withIndex
Copy the current immutable object by setting a value for theindexattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for index- Returns:
- A modified copy of the
thisobject
-
equals
This instance is equal to all instances ofImmutableNfTokenPageObjectthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:ledgerEntryType,nfTokens,nextPageMin,previousPageMin,previousTransactionId,previousTransactionLedgerSequence,index. -
toString
Prints the immutable valueNfTokenPageObjectwith attribute values. -
copyOf
Creates an immutable copy of aNfTokenPageObjectvalue. 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 NfTokenPageObject instance
-
builder
Creates a builder forImmutableNfTokenPageObject.ImmutableNfTokenPageObject.builder() .addNfTokens|addAllNfTokens(org.xrpl.xrpl4j.model.ledger.NfTokenWrapper) //nfTokenselements .nextPageMin(org.xrpl.xrpl4j.model.transactions.Hash256) // optionalnextPageMin.previousPageMin(org.xrpl.xrpl4j.model.transactions.Hash256) // optionalpreviousPageMin.previousTransactionId(org.xrpl.xrpl4j.model.transactions.Hash256) // optionalpreviousTransactionId.previousTransactionLedgerSequence(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optionalpreviousTransactionLedgerSequence.index(org.xrpl.xrpl4j.model.transactions.Hash256) // requiredindex.build();- Returns:
- A new ImmutableNfTokenPageObject builder
-