xrpl::ledger_entries::NFTokenPageBuilder Class Reference

Builder for NFTokenPage ledger entries. More...

#include <NFTokenPage.h>

Inheritance diagram for xrpl::ledger_entries::NFTokenPageBuilder:

Collaboration diagram for xrpl::ledger_entries::NFTokenPageBuilder:

Public Member Functions
	NFTokenPageBuilder (STArray const &nFTokens, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
	Construct a new NFTokenPageBuilder with required fields.
	NFTokenPageBuilder (SLE::const_pointer sle)
	Construct a NFTokenPageBuilder from an existing SLE object.
NFTokenPageBuilder &	setPreviousPageMin (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Ledger entry-specific field setters.
NFTokenPageBuilder &	setNextPageMin (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfNextPageMin (SoeOptional).
NFTokenPageBuilder &	setNFTokens (STArray const &value)
	Set sfNFTokens (SoeRequired).
NFTokenPageBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (SoeRequired).
NFTokenPageBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeRequired).
NFTokenPage	build (uint256 const &index)
	Build and return the completed NFTokenPage wrapper.
bool	validate () const
	Validate the ledger entry.
NFTokenPageBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
NFTokenPageBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for NFTokenPage ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses STObject internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 138 of file NFTokenPage.h.

Constructor & Destructor Documentation

NFTokenPageBuilder() [1/2]

xrpl::ledger_entries::NFTokenPageBuilder::NFTokenPageBuilder	(	STArray const &	nFTokens,
		std::decay_t< typename SF_UINT256::type::value_type > const &	previousTxnID,
		std::decay_t< typename SF_UINT32::type::value_type > const &	previousTxnLgrSeq )

Construct a new NFTokenPageBuilder with required fields.

Parameters

nFTokens	The sfNFTokens field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 147 of file NFTokenPage.h.

NFTokenPageBuilder() [2/2]

xrpl::ledger_entries::NFTokenPageBuilder::NFTokenPageBuilder

(

SLE::const_pointer

sle

)

Construct a NFTokenPageBuilder from an existing SLE object.

Parameters

sle	The existing ledger entry to copy from.

Exceptions

std::runtime_error

if the ledger entry type doesn't match.

Definition at line 160 of file NFTokenPage.h.

Member Function Documentation

setPreviousPageMin()

NFTokenPageBuilder & xrpl::ledger_entries::NFTokenPageBuilder::setPreviousPageMin

(

std::decay_t< typename SF_UINT256::type::value_type > const &

value

)

Ledger entry-specific field setters.

Set sfPreviousPageMin (SoeOptional)

Returns

Reference to this builder for method chaining.

Definition at line 176 of file NFTokenPage.h.

setNextPageMin()

NFTokenPageBuilder & xrpl::ledger_entries::NFTokenPageBuilder::setNextPageMin

(

std::decay_t< typename SF_UINT256::type::value_type > const &

value

)

Set sfNextPageMin (SoeOptional).

Returns

Reference to this builder for method chaining.

Definition at line 187 of file NFTokenPage.h.

setNFTokens()

NFTokenPageBuilder & xrpl::ledger_entries::NFTokenPageBuilder::setNFTokens

(

STArray const &

value

)

Set sfNFTokens (SoeRequired).

Returns

Reference to this builder for method chaining.

Definition at line 198 of file NFTokenPage.h.

setPreviousTxnID()

NFTokenPageBuilder & xrpl::ledger_entries::NFTokenPageBuilder::setPreviousTxnID

(

std::decay_t< typename SF_UINT256::type::value_type > const &

value

)

Set sfPreviousTxnID (SoeRequired).

Returns

Reference to this builder for method chaining.

Definition at line 209 of file NFTokenPage.h.

setPreviousTxnLgrSeq()

NFTokenPageBuilder & xrpl::ledger_entries::NFTokenPageBuilder::setPreviousTxnLgrSeq

(

std::decay_t< typename SF_UINT32::type::value_type > const &

value

)

Set sfPreviousTxnLgrSeq (SoeRequired).

Returns

Reference to this builder for method chaining.

Definition at line 220 of file NFTokenPage.h.

build()

NFTokenPage xrpl::ledger_entries::NFTokenPageBuilder::build

(

uint256 const &

index

)

Build and return the completed NFTokenPage wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 232 of file NFTokenPage.h.

validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< NFTokenPageBuilder >::validate ( ) const

nodiscardinherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

NFTokenPageBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< NFTokenPageBuilder >::setLedgerIndex ( uint256 const & value )

inherited

Set the ledger index.

Parameters

value

Ledger index

Returns

Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

setFlags()

NFTokenPageBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< NFTokenPageBuilder >::setFlags ( uint32_t value )

inherited

Set the flags.

Parameters

value

Flags value

Returns

Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

object_

STObject xrpl::ledger_entries::LedgerEntryBuilderBase< NFTokenPageBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.