xrpl::ledger_entries::MPTokenBuilder Class Reference

Builder for MPToken ledger entries. More...

#include <MPToken.h>

Inheritance diagram for xrpl::ledger_entries::MPTokenBuilder:

Collaboration diagram for xrpl::ledger_entries::MPTokenBuilder:

Public Member Functions
	MPTokenBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_UINT192::type::value_type > const &mPTokenIssuanceID, 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 MPTokenBuilder with required fields.
	MPTokenBuilder (std::shared_ptr< SLE const > sle)
	Construct a MPTokenBuilder from an existing SLE object.
MPTokenBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
MPTokenBuilder &	setMPTokenIssuanceID (std::decay_t< typename SF_UINT192::type::value_type > const &value)
	Set sfMPTokenIssuanceID (soeREQUIRED)
MPTokenBuilder &	setMPTAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfMPTAmount (soeDEFAULT)
MPTokenBuilder &	setLockedAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfLockedAmount (soeOPTIONAL)
MPTokenBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
MPTokenBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
MPTokenBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
MPToken	build (uint256 const &index)
	Build and return the completed MPToken wrapper.
bool	validate () const
	Validate the ledger entry.
MPTokenBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
MPTokenBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for MPToken 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 159 of file MPToken.h.

Constructor & Destructor Documentation

MPTokenBuilder() [1/2]

xrpl::ledger_entries::MPTokenBuilder::MPTokenBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_UINT192::type::value_type > const &	mPTokenIssuanceID,
		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 MPTokenBuilder with required fields.

Parameters

account	The sfAccount field value.
mPTokenIssuanceID	The sfMPTokenIssuanceID field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 170 of file MPToken.h.

MPTokenBuilder() [2/2]

xrpl::ledger_entries::MPTokenBuilder::MPTokenBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a MPTokenBuilder 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 185 of file MPToken.h.

Member Function Documentation

setAccount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::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 201 of file MPToken.h.

setMPTokenIssuanceID()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setMPTokenIssuanceID

(

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

value

)

Set sfMPTokenIssuanceID (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 212 of file MPToken.h.

setMPTAmount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setMPTAmount

(

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

value

)

Set sfMPTAmount (soeDEFAULT)

Returns

Reference to this builder for method chaining.

Definition at line 223 of file MPToken.h.

setLockedAmount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setLockedAmount

(

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

value

)

Set sfLockedAmount (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 234 of file MPToken.h.

setOwnerNode()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::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 245 of file MPToken.h.

setPreviousTxnID()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::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 256 of file MPToken.h.

setPreviousTxnLgrSeq()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::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 267 of file MPToken.h.

build()

MPToken xrpl::ledger_entries::MPTokenBuilder::build

(

uint256 const &

index

)

Build and return the completed MPToken wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 279 of file MPToken.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.