Builder for DirectoryNode ledger entries. More...

#include <DirectoryNode.h>

Inheritance diagram for xrpl::ledger_entries::DirectoryNodeBuilder:

Collaboration diagram for xrpl::ledger_entries::DirectoryNodeBuilder:

[legend]

Public Member Functions
	DirectoryNodeBuilder (std::decay_t< typename SF_VECTOR256::type::value_type > const &indexes, std::decay_t< typename SF_UINT256::type::value_type > const &rootIndex)
	Construct a new DirectoryNodeBuilder with required fields.
	DirectoryNodeBuilder (SLE::const_pointer sle)
	Construct a DirectoryNodeBuilder from an existing SLE object.
DirectoryNodeBuilder &	setOwner (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
DirectoryNodeBuilder &	setTakerPaysCurrency (std::decay_t< typename SF_UINT160::type::value_type > const &value)
	Set sfTakerPaysCurrency (SoeOptional).
DirectoryNodeBuilder &	setTakerPaysIssuer (std::decay_t< typename SF_UINT160::type::value_type > const &value)
	Set sfTakerPaysIssuer (SoeOptional).
DirectoryNodeBuilder &	setTakerPaysMPT (std::decay_t< typename SF_UINT192::type::value_type > const &value)
	Set sfTakerPaysMPT (SoeOptional).
DirectoryNodeBuilder &	setTakerGetsCurrency (std::decay_t< typename SF_UINT160::type::value_type > const &value)
	Set sfTakerGetsCurrency (SoeOptional).
DirectoryNodeBuilder &	setTakerGetsIssuer (std::decay_t< typename SF_UINT160::type::value_type > const &value)
	Set sfTakerGetsIssuer (SoeOptional).
DirectoryNodeBuilder &	setTakerGetsMPT (std::decay_t< typename SF_UINT192::type::value_type > const &value)
	Set sfTakerGetsMPT (SoeOptional).
DirectoryNodeBuilder &	setExchangeRate (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfExchangeRate (SoeOptional).
DirectoryNodeBuilder &	setIndexes (std::decay_t< typename SF_VECTOR256::type::value_type > const &value)
	Set sfIndexes (SoeRequired).
DirectoryNodeBuilder &	setRootIndex (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfRootIndex (SoeRequired).
DirectoryNodeBuilder &	setIndexNext (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfIndexNext (SoeOptional).
DirectoryNodeBuilder &	setIndexPrevious (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfIndexPrevious (SoeOptional).
DirectoryNodeBuilder &	setNFTokenID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfNFTokenID (SoeOptional).
DirectoryNodeBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (SoeOptional).
DirectoryNodeBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeOptional).
DirectoryNodeBuilder &	setDomainID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfDomainID (SoeOptional).
DirectoryNode	build (uint256 const &index)
	Build and return the completed DirectoryNode wrapper.
bool	validate () const
	Validate the ledger entry.
DirectoryNodeBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
DirectoryNodeBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for DirectoryNode 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 414 of file DirectoryNode.h.

Constructor & Destructor Documentation

◆ DirectoryNodeBuilder() [1/2]

xrpl::ledger_entries::DirectoryNodeBuilder::DirectoryNodeBuilder	(	std::decay_t< typename SF_VECTOR256::type::value_type > const &	indexes,
		std::decay_t< typename SF_UINT256::type::value_type > const &	rootIndex )

Construct a new DirectoryNodeBuilder with required fields.

Parameters

indexes	The sfIndexes field value.
rootIndex	The sfRootIndex field value.

Definition at line 422 of file DirectoryNode.h.

◆ DirectoryNodeBuilder() [2/2]

xrpl::ledger_entries::DirectoryNodeBuilder::DirectoryNodeBuilder ( SLE::const_pointer sle )

Construct a DirectoryNodeBuilder 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 434 of file DirectoryNode.h.

Member Function Documentation

◆ setOwner()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setOwner ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Ledger entry-specific field setters.

Set sfOwner (SoeOptional)

Returns: Reference to this builder for method chaining.

Definition at line 450 of file DirectoryNode.h.

◆ setTakerPaysCurrency()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerPaysCurrency ( std::decay_t< typename SF_UINT160::type::value_type > const & value )

Set sfTakerPaysCurrency (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 461 of file DirectoryNode.h.

◆ setTakerPaysIssuer()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerPaysIssuer ( std::decay_t< typename SF_UINT160::type::value_type > const & value )

Set sfTakerPaysIssuer (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 472 of file DirectoryNode.h.

◆ setTakerPaysMPT()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerPaysMPT ( std::decay_t< typename SF_UINT192::type::value_type > const & value )

Set sfTakerPaysMPT (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 483 of file DirectoryNode.h.

◆ setTakerGetsCurrency()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerGetsCurrency ( std::decay_t< typename SF_UINT160::type::value_type > const & value )

Set sfTakerGetsCurrency (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 494 of file DirectoryNode.h.

◆ setTakerGetsIssuer()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerGetsIssuer ( std::decay_t< typename SF_UINT160::type::value_type > const & value )

Set sfTakerGetsIssuer (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 505 of file DirectoryNode.h.

◆ setTakerGetsMPT()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setTakerGetsMPT ( std::decay_t< typename SF_UINT192::type::value_type > const & value )

Set sfTakerGetsMPT (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 516 of file DirectoryNode.h.

◆ setExchangeRate()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setExchangeRate ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfExchangeRate (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 527 of file DirectoryNode.h.

◆ setIndexes()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setIndexes ( std::decay_t< typename SF_VECTOR256::type::value_type > const & value )

Set sfIndexes (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 538 of file DirectoryNode.h.

◆ setRootIndex()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setRootIndex ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfRootIndex (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 549 of file DirectoryNode.h.

◆ setIndexNext()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setIndexNext ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfIndexNext (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 560 of file DirectoryNode.h.

◆ setIndexPrevious()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setIndexPrevious ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfIndexPrevious (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 571 of file DirectoryNode.h.

◆ setNFTokenID()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setNFTokenID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfNFTokenID (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 582 of file DirectoryNode.h.

◆ setPreviousTxnID()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setPreviousTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfPreviousTxnID (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 593 of file DirectoryNode.h.

◆ setPreviousTxnLgrSeq()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setPreviousTxnLgrSeq ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfPreviousTxnLgrSeq (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 604 of file DirectoryNode.h.

◆ setDomainID()

DirectoryNodeBuilder & xrpl::ledger_entries::DirectoryNodeBuilder::setDomainID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfDomainID (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 615 of file DirectoryNode.h.

◆ build()

DirectoryNode xrpl::ledger_entries::DirectoryNodeBuilder::build ( uint256 const & index )

Build and return the completed DirectoryNode wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 627 of file DirectoryNode.h.

◆ validate()

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

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

DirectoryNodeBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< DirectoryNodeBuilder >::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()

DirectoryNodeBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< DirectoryNodeBuilder >::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< DirectoryNodeBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DirectoryNodeBuilder() [1/2]

◆ DirectoryNodeBuilder() [2/2]

Member Function Documentation

◆ setOwner()

◆ setTakerPaysCurrency()

◆ setTakerPaysIssuer()

◆ setTakerPaysMPT()

◆ setTakerGetsCurrency()

◆ setTakerGetsIssuer()

◆ setTakerGetsMPT()

◆ setExchangeRate()

◆ setIndexes()

◆ setRootIndex()

◆ setIndexNext()

◆ setIndexPrevious()

◆ setNFTokenID()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setDomainID()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_