xrpl::ledger_entries::LedgerEntryBuilderBase< Derived > Class Template Reference

Base class for all ledger entry builders. More...

#include <LedgerEntryBuilderBase.h>

Collaboration diagram for xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >:

Public Member Functions
	LedgerEntryBuilderBase ()=default
	LedgerEntryBuilderBase (SF_UINT16::type::value_type ledgerEntryType, SF_UINT32::type::value_type flags=0)
bool	validate () const
	Validate the ledger entry.
Derived &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
Derived &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_ {sfLedgerEntry}

Detailed Description

template<typename Derived>
class xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >

Base class for all ledger entry builders.

Provides common field setters that are available for all ledger entry types.

Definition at line 20 of file LedgerEntryBuilderBase.h.

Constructor & Destructor Documentation

LedgerEntryBuilderBase() [1/2]

template<typename Derived>

xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >::LedgerEntryBuilderBase ( )

default

LedgerEntryBuilderBase() [2/2]

template<typename Derived>

xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >::LedgerEntryBuilderBase	(	SF_UINT16::type::value_type	ledgerEntryType,
		SF_UINT32::type::value_type	flags = 0 )

Definition at line 25 of file LedgerEntryBuilderBase.h.

Member Function Documentation

validate()

template<typename Derived>

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

nodiscard

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

template<typename Derived>

Derived & xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >::setLedgerIndex

(

uint256 const &

value

)

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()

template<typename Derived>

Derived & xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >::setFlags

(

uint32_t

value

)

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_

template<typename Derived>

STObject xrpl::ledger_entries::LedgerEntryBuilderBase< Derived >::object_ {sfLedgerEntry}

protected

Definition at line 81 of file LedgerEntryBuilderBase.h.