xrpl::ledger_entries::DIDBuilder Class Reference

Builder for DID ledger entries. More...

#include <DID.h>

Inheritance diagram for xrpl::ledger_entries::DIDBuilder:

Collaboration diagram for xrpl::ledger_entries::DIDBuilder:

Public Member Functions
	DIDBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, 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 DIDBuilder with required fields.
	DIDBuilder (std::shared_ptr< SLE const > sle)
	Construct a DIDBuilder from an existing SLE object.
DIDBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
DIDBuilder &	setDIDDocument (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfDIDDocument (soeOPTIONAL)
DIDBuilder &	setURI (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfURI (soeOPTIONAL)
DIDBuilder &	setData (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfData (soeOPTIONAL)
DIDBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
DIDBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
DIDBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
DID	build (uint256 const &index)
	Build and return the completed DID wrapper.
bool	validate () const
	Validate the ledger entry.
DIDBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
DIDBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for DID 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 172 of file DID.h.

Constructor & Destructor Documentation

DIDBuilder() [1/2]

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

Parameters

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

Definition at line 182 of file DID.h.

DIDBuilder() [2/2]

xrpl::ledger_entries::DIDBuilder::DIDBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a DIDBuilder 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 196 of file DID.h.

Member Function Documentation

setAccount()

DIDBuilder & xrpl::ledger_entries::DIDBuilder::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 212 of file DID.h.

setDIDDocument()

DIDBuilder & xrpl::ledger_entries::DIDBuilder::setDIDDocument

(

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

value

)

Set sfDIDDocument (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 223 of file DID.h.

setURI()

DIDBuilder & xrpl::ledger_entries::DIDBuilder::setURI

(

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

value

)

Set sfURI (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 234 of file DID.h.

setData()

DIDBuilder & xrpl::ledger_entries::DIDBuilder::setData

(

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

value

)

Set sfData (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 245 of file DID.h.

setOwnerNode()

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

setPreviousTxnID()

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

setPreviousTxnLgrSeq()

DIDBuilder & xrpl::ledger_entries::DIDBuilder::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 278 of file DID.h.

build()

DID xrpl::ledger_entries::DIDBuilder::build

(

uint256 const &

index

)

Build and return the completed DID wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 290 of file DID.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.