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 (std::shared_ptr< SLE const > 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 &	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 &	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 Json::Value internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 366 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 374 of file DirectoryNode.h.

◆ DirectoryNodeBuilder() [2/2]

xrpl::ledger_entries::DirectoryNodeBuilder::DirectoryNodeBuilder ( std::shared_ptr< SLE const > 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 386 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 402 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 413 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 424 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 435 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 446 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 457 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 468 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 479 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 490 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 501 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 512 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 523 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 534 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 545 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 557 of file DirectoryNode.h.

◆ validate()

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

inherited

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()

◆ setTakerGetsCurrency()

◆ setTakerGetsIssuer()

◆ setExchangeRate()

◆ setIndexes()

◆ setRootIndex()

◆ setIndexNext()

◆ setIndexPrevious()

◆ setNFTokenID()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setDomainID()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_