Builder for Credential ledger entries. More...

#include <Credential.h>

Inheritance diagram for xrpl::ledger_entries::CredentialBuilder:

Collaboration diagram for xrpl::ledger_entries::CredentialBuilder:

[legend]

Public Member Functions
	CredentialBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &subject, std::decay_t< typename SF_ACCOUNT::type::value_type > const &issuer, std::decay_t< typename SF_VL::type::value_type > const &credentialType, std::decay_t< typename SF_UINT64::type::value_type > const &issuerNode, 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 CredentialBuilder with required fields.

	CredentialBuilder (std::shared_ptr< SLE const > sle)
	Construct a CredentialBuilder from an existing SLE object.

CredentialBuilder &	setSubject (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.

CredentialBuilder &	setIssuer (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfIssuer (soeREQUIRED)

CredentialBuilder &	setCredentialType (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfCredentialType (soeREQUIRED)

CredentialBuilder &	setExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfExpiration (soeOPTIONAL)

CredentialBuilder &	setURI (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfURI (soeOPTIONAL)

CredentialBuilder &	setIssuerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfIssuerNode (soeREQUIRED)

CredentialBuilder &	setSubjectNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfSubjectNode (soeOPTIONAL)

CredentialBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)

CredentialBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)

Credential	build (uint256 const &index)
	Build and return the completed Credential wrapper.

bool	validate () const
	Validate the ledger entry.

CredentialBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.

CredentialBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Credential 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 194 of file Credential.h.

Constructor & Destructor Documentation

◆ CredentialBuilder() [1/2]

xrpl::ledger_entries::CredentialBuilder::CredentialBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	subject,
		std::decay_t< typename SF_ACCOUNT::type::value_type > const &	issuer,
		std::decay_t< typename SF_VL::type::value_type > const &	credentialType,
		std::decay_t< typename SF_UINT64::type::value_type > const &	issuerNode,
		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 CredentialBuilder with required fields.

Parameters

subject	The sfSubject field value.
issuer	The sfIssuer field value.
credentialType	The sfCredentialType field value.
issuerNode	The sfIssuerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 206 of file Credential.h.

◆ CredentialBuilder() [2/2]

xrpl::ledger_entries::CredentialBuilder::CredentialBuilder ( std::shared_ptr< SLE const > sle )

Construct a CredentialBuilder 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 222 of file Credential.h.

Member Function Documentation

◆ setSubject()

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

Ledger entry-specific field setters.

Set sfSubject (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 238 of file Credential.h.

◆ setIssuer()

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

Set sfIssuer (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 249 of file Credential.h.

◆ setCredentialType()

CredentialBuilder & xrpl::ledger_entries::CredentialBuilder::setCredentialType ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfCredentialType (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 260 of file Credential.h.

◆ setExpiration()

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

Set sfExpiration (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 271 of file Credential.h.

◆ setURI()

CredentialBuilder & xrpl::ledger_entries::CredentialBuilder::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 282 of file Credential.h.

◆ setIssuerNode()

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

Set sfIssuerNode (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 293 of file Credential.h.

◆ setSubjectNode()

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

Set sfSubjectNode (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 304 of file Credential.h.

◆ setPreviousTxnID()

CredentialBuilder & xrpl::ledger_entries::CredentialBuilder::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 315 of file Credential.h.

◆ setPreviousTxnLgrSeq()

CredentialBuilder & xrpl::ledger_entries::CredentialBuilder::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 326 of file Credential.h.

◆ build()

Credential xrpl::ledger_entries::CredentialBuilder::build ( uint256 const & index )

Build and return the completed Credential wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 338 of file Credential.h.

◆ validate()

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

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CredentialBuilder() [1/2]

◆ CredentialBuilder() [2/2]

Member Function Documentation

◆ setSubject()

◆ setIssuer()

◆ setCredentialType()

◆ setExpiration()

◆ setURI()

◆ setIssuerNode()

◆ setSubjectNode()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_