xrpl::ledger_entries::CheckBuilder Class Reference

Builder for Check ledger entries. More...

#include <Check.h>

Inheritance diagram for xrpl::ledger_entries::CheckBuilder:

Collaboration diagram for xrpl::ledger_entries::CheckBuilder:

Public Member Functions
	CheckBuilder (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 &sendMax, std::decay_t< typename SF_UINT32::type::value_type > const &sequence, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT64::type::value_type > const &destinationNode, 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 CheckBuilder with required fields.
	CheckBuilder (std::shared_ptr< SLE const > sle)
	Construct a CheckBuilder from an existing SLE object.
CheckBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
CheckBuilder &	setDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfDestination (soeREQUIRED)
CheckBuilder &	setSendMax (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfSendMax (soeREQUIRED)
CheckBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeREQUIRED)
CheckBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
CheckBuilder &	setDestinationNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfDestinationNode (soeREQUIRED)
CheckBuilder &	setExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfExpiration (soeOPTIONAL)
CheckBuilder &	setInvoiceID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfInvoiceID (soeOPTIONAL)
CheckBuilder &	setSourceTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSourceTag (soeOPTIONAL)
CheckBuilder &	setDestinationTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfDestinationTag (soeOPTIONAL)
CheckBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
CheckBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
Check	build (uint256 const &index)
	Build and return the completed Check wrapper.
bool	validate () const
	Validate the ledger entry.
CheckBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
CheckBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Check 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 240 of file Check.h.

Constructor & Destructor Documentation

CheckBuilder() [1/2]

xrpl::ledger_entries::CheckBuilder::CheckBuilder	(	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 &	sendMax,
		std::decay_t< typename SF_UINT32::type::value_type > const &	sequence,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		std::decay_t< typename SF_UINT64::type::value_type > const &	destinationNode,
		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 CheckBuilder with required fields.

Parameters

account	The sfAccount field value.
destination	The sfDestination field value.
sendMax	The sfSendMax field value.
sequence	The sfSequence field value.
ownerNode	The sfOwnerNode field value.
destinationNode	The sfDestinationNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 254 of file Check.h.

CheckBuilder() [2/2]

xrpl::ledger_entries::CheckBuilder::CheckBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a CheckBuilder 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 272 of file Check.h.

Member Function Documentation

setAccount()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 288 of file Check.h.

setDestination()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 299 of file Check.h.

setSendMax()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::setSendMax

(

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

value

)

Set sfSendMax (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 310 of file Check.h.

setSequence()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::setSequence

(

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

value

)

Set sfSequence (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 321 of file Check.h.

setOwnerNode()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 332 of file Check.h.

setDestinationNode()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::setDestinationNode

(

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

value

)

Set sfDestinationNode (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 343 of file Check.h.

setExpiration()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::setExpiration

(

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

value

)

Set sfExpiration (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 354 of file Check.h.

setInvoiceID()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::setInvoiceID

(

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

value

)

Set sfInvoiceID (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 365 of file Check.h.

setSourceTag()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 376 of file Check.h.

setDestinationTag()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 387 of file Check.h.

setPreviousTxnID()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 398 of file Check.h.

setPreviousTxnLgrSeq()

CheckBuilder & xrpl::ledger_entries::CheckBuilder::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 409 of file Check.h.

build()

Check xrpl::ledger_entries::CheckBuilder::build

(

uint256 const &

index

)

Build and return the completed Check wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 421 of file Check.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.