Builder for RippleState ledger entries. More...

#include <RippleState.h>

Inheritance diagram for xrpl::ledger_entries::RippleStateBuilder:

Collaboration diagram for xrpl::ledger_entries::RippleStateBuilder:

[legend]

Public Member Functions
	RippleStateBuilder (std::decay_t< typename SF_AMOUNT::type::value_type > const &balance, std::decay_t< typename SF_AMOUNT::type::value_type > const &lowLimit, std::decay_t< typename SF_AMOUNT::type::value_type > const &highLimit, 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 RippleStateBuilder with required fields.
	RippleStateBuilder (SLE::const_pointer sle)
	Construct a RippleStateBuilder from an existing SLE object.
RippleStateBuilder &	setBalance (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
RippleStateBuilder &	setLowLimit (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfLowLimit (SoeRequired).
RippleStateBuilder &	setHighLimit (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfHighLimit (SoeRequired).
RippleStateBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (SoeRequired).
RippleStateBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeRequired).
RippleStateBuilder &	setLowNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfLowNode (SoeOptional).
RippleStateBuilder &	setLowQualityIn (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfLowQualityIn (SoeOptional).
RippleStateBuilder &	setLowQualityOut (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfLowQualityOut (SoeOptional).
RippleStateBuilder &	setHighNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfHighNode (SoeOptional).
RippleStateBuilder &	setHighQualityIn (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfHighQualityIn (SoeOptional).
RippleStateBuilder &	setHighQualityOut (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfHighQualityOut (SoeOptional).
RippleStateBuilder &	setHighSponsor (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfHighSponsor (SoeOptional).
RippleStateBuilder &	setLowSponsor (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfLowSponsor (SoeOptional).
RippleState	build (uint256 const &index)
	Build and return the completed RippleState wrapper.
bool	validate () const
	Validate the ledger entry.
RippleStateBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
RippleStateBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for RippleState 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 303 of file RippleState.h.

Constructor & Destructor Documentation

◆ RippleStateBuilder() [1/2]

xrpl::ledger_entries::RippleStateBuilder::RippleStateBuilder	(	std::decay_t< typename SF_AMOUNT::type::value_type > const &	balance,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	lowLimit,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	highLimit,
		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 RippleStateBuilder with required fields.

Parameters

balance	The sfBalance field value.
lowLimit	The sfLowLimit field value.
highLimit	The sfHighLimit field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 314 of file RippleState.h.

◆ RippleStateBuilder() [2/2]

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

Construct a RippleStateBuilder 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 329 of file RippleState.h.

Member Function Documentation

◆ setBalance()

RippleStateBuilder & xrpl::ledger_entries::RippleStateBuilder::setBalance ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Ledger entry-specific field setters.

Set sfBalance (SoeRequired)

Returns: Reference to this builder for method chaining.

Definition at line 347 of file RippleState.h.

◆ setLowLimit()

RippleStateBuilder & xrpl::ledger_entries::RippleStateBuilder::setLowLimit ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfLowLimit (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 358 of file RippleState.h.

◆ setHighLimit()

RippleStateBuilder & xrpl::ledger_entries::RippleStateBuilder::setHighLimit ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfHighLimit (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 369 of file RippleState.h.

◆ setPreviousTxnID()

RippleStateBuilder & xrpl::ledger_entries::RippleStateBuilder::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 380 of file RippleState.h.

◆ setPreviousTxnLgrSeq()

RippleStateBuilder & xrpl::ledger_entries::RippleStateBuilder::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 391 of file RippleState.h.

◆ setLowNode()

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

Set sfLowNode (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 402 of file RippleState.h.

◆ setLowQualityIn()

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

Set sfLowQualityIn (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 413 of file RippleState.h.

◆ setLowQualityOut()

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

Set sfLowQualityOut (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 424 of file RippleState.h.

◆ setHighNode()

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

Set sfHighNode (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 435 of file RippleState.h.

◆ setHighQualityIn()

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

Set sfHighQualityIn (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 446 of file RippleState.h.

◆ setHighQualityOut()

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

Set sfHighQualityOut (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 457 of file RippleState.h.

◆ setHighSponsor()

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

Set sfHighSponsor (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 468 of file RippleState.h.

◆ setLowSponsor()

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

Set sfLowSponsor (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 479 of file RippleState.h.

◆ build()

RippleState xrpl::ledger_entries::RippleStateBuilder::build ( uint256 const & index )

Build and return the completed RippleState wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 491 of file RippleState.h.

◆ validate()

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

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RippleStateBuilder() [1/2]

◆ RippleStateBuilder() [2/2]

Member Function Documentation

◆ setBalance()

◆ setLowLimit()

◆ setHighLimit()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setLowNode()

◆ setLowQualityIn()

◆ setLowQualityOut()

◆ setHighNode()

◆ setHighQualityIn()

◆ setHighQualityOut()

◆ setHighSponsor()

◆ setLowSponsor()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_