xrpl::ledger_entries::AmendmentsBuilder Class Reference

Builder for Amendments ledger entries. More...

#include <Amendments.h>

Inheritance diagram for xrpl::ledger_entries::AmendmentsBuilder:

Collaboration diagram for xrpl::ledger_entries::AmendmentsBuilder:

Public Member Functions
	AmendmentsBuilder ()
	Construct a new AmendmentsBuilder with required fields.
	AmendmentsBuilder (SLE::const_pointer sle)
	Construct a AmendmentsBuilder from an existing SLE object.
AmendmentsBuilder &	setAmendments (std::decay_t< typename SF_VECTOR256::type::value_type > const &value)
	Ledger entry-specific field setters.
AmendmentsBuilder &	setMajorities (STArray const &value)
	Set sfMajorities (SoeOptional).
AmendmentsBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (SoeOptional).
AmendmentsBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeOptional).
Amendments	build (uint256 const &index)
	Build and return the completed Amendments wrapper.
bool	validate () const
	Validate the ledger entry.
AmendmentsBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
AmendmentsBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Amendments 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 153 of file Amendments.h.

Constructor & Destructor Documentation

AmendmentsBuilder() [1/2]

xrpl::ledger_entries::AmendmentsBuilder::AmendmentsBuilder

(

)

Construct a new AmendmentsBuilder with required fields.

Definition at line 159 of file Amendments.h.

AmendmentsBuilder() [2/2]

xrpl::ledger_entries::AmendmentsBuilder::AmendmentsBuilder

(

SLE::const_pointer

sle

)

Construct a AmendmentsBuilder 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 169 of file Amendments.h.

Member Function Documentation

setAmendments()

AmendmentsBuilder & xrpl::ledger_entries::AmendmentsBuilder::setAmendments

(

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

value

)

Ledger entry-specific field setters.

Set sfAmendments (SoeOptional)

Returns

Reference to this builder for method chaining.

Definition at line 185 of file Amendments.h.

setMajorities()

AmendmentsBuilder & xrpl::ledger_entries::AmendmentsBuilder::setMajorities

(

STArray const &

value

)

Set sfMajorities (SoeOptional).

Returns

Reference to this builder for method chaining.

Definition at line 196 of file Amendments.h.

setPreviousTxnID()

AmendmentsBuilder & xrpl::ledger_entries::AmendmentsBuilder::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 207 of file Amendments.h.

setPreviousTxnLgrSeq()

AmendmentsBuilder & xrpl::ledger_entries::AmendmentsBuilder::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 218 of file Amendments.h.

build()

Amendments xrpl::ledger_entries::AmendmentsBuilder::build

(

uint256 const &

index

)

Build and return the completed Amendments wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 230 of file Amendments.h.

validate()

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

nodiscardinherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.