xrpl::ledger_entries::EscrowBuilder Class Reference

Builder for Escrow ledger entries. More...

#include <Escrow.h>

Inheritance diagram for xrpl::ledger_entries::EscrowBuilder:

Collaboration diagram for xrpl::ledger_entries::EscrowBuilder:

Public Member Functions
	EscrowBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_ACCOUNT::type::value_type > const &destination, std::decay_t< typename SF_AMOUNT::type::value_type > const &amount, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, 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 EscrowBuilder with required fields.
	EscrowBuilder (std::shared_ptr< SLE const > sle)
	Construct a EscrowBuilder from an existing SLE object.
EscrowBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
EscrowBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeOPTIONAL)
EscrowBuilder &	setDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfDestination (soeREQUIRED)
EscrowBuilder &	setAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfAmount (soeREQUIRED)
EscrowBuilder &	setCondition (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfCondition (soeOPTIONAL)
EscrowBuilder &	setCancelAfter (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfCancelAfter (soeOPTIONAL)
EscrowBuilder &	setFinishAfter (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfFinishAfter (soeOPTIONAL)
EscrowBuilder &	setSourceTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSourceTag (soeOPTIONAL)
EscrowBuilder &	setDestinationTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfDestinationTag (soeOPTIONAL)
EscrowBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
EscrowBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
EscrowBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
EscrowBuilder &	setDestinationNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfDestinationNode (soeOPTIONAL)
EscrowBuilder &	setTransferRate (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfTransferRate (soeOPTIONAL)
EscrowBuilder &	setIssuerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfIssuerNode (soeOPTIONAL)
Escrow	build (uint256 const &index)
	Build and return the completed Escrow wrapper.
bool	validate () const
	Validate the ledger entry.
EscrowBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
EscrowBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Escrow 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 338 of file Escrow.h.

Constructor & Destructor Documentation

EscrowBuilder() [1/2]

xrpl::ledger_entries::EscrowBuilder::EscrowBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_ACCOUNT::type::value_type > const &	destination,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	amount,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		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 EscrowBuilder with required fields.

Parameters

account	The sfAccount field value.
destination	The sfDestination field value.
amount	The sfAmount field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 350 of file Escrow.h.

EscrowBuilder() [2/2]

xrpl::ledger_entries::EscrowBuilder::EscrowBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a EscrowBuilder 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 366 of file Escrow.h.

Member Function Documentation

setAccount()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setAccount

(

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

value

)

Ledger entry-specific field setters.

Set sfAccount (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 382 of file Escrow.h.

setSequence()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setSequence

(

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

value

)

Set sfSequence (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 393 of file Escrow.h.

setDestination()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setDestination

(

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

value

)

Set sfDestination (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 404 of file Escrow.h.

setAmount()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setAmount

(

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

value

)

Set sfAmount (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 415 of file Escrow.h.

setCondition()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setCondition

(

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

value

)

Set sfCondition (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 426 of file Escrow.h.

setCancelAfter()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setCancelAfter

(

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

value

)

Set sfCancelAfter (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 437 of file Escrow.h.

setFinishAfter()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setFinishAfter

(

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

value

)

Set sfFinishAfter (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 448 of file Escrow.h.

setSourceTag()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setSourceTag

(

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

value

)

Set sfSourceTag (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 459 of file Escrow.h.

setDestinationTag()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setDestinationTag

(

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

value

)

Set sfDestinationTag (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 470 of file Escrow.h.

setOwnerNode()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setOwnerNode

(

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

value

)

Set sfOwnerNode (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 481 of file Escrow.h.

setPreviousTxnID()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::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 492 of file Escrow.h.

setPreviousTxnLgrSeq()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::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 503 of file Escrow.h.

setDestinationNode()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setDestinationNode

(

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

value

)

Set sfDestinationNode (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 514 of file Escrow.h.

setTransferRate()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setTransferRate

(

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

value

)

Set sfTransferRate (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 525 of file Escrow.h.

setIssuerNode()

EscrowBuilder & xrpl::ledger_entries::EscrowBuilder::setIssuerNode

(

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

value

)

Set sfIssuerNode (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 536 of file Escrow.h.

build()

Escrow xrpl::ledger_entries::EscrowBuilder::build

(

uint256 const &

index

)

Build and return the completed Escrow wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 548 of file Escrow.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.