Interface MongoTransactionOptions

All Superinterfaces:

ReadConcernAware, ReadPreferenceAware, TransactionMetadata, WriteConcernAware

public interface MongoTransactionOptions
extends TransactionMetadata, ReadConcernAware, ReadPreferenceAware, WriteConcernAware

Options to be applied within a specific transaction scope.

Since:

4.3

Author:

Christoph Strobl

Field Summary

Fields

Modifier and Type	Field	Description
static final MongoTransactionOptions	NONE	Value Object representing empty options enforcing client defaults.

Method Summary

Modifier and Type	Method	Description
default <T> T	map(Function<MongoTransactionOptions, T> mappingFunction)	Apply the current options using the given mapping Function and return its result.
default MongoTransactionOptions	mergeWith(@Nullable MongoTransactionOptions fallbackOptions)	Merge current options with given ones.
static MongoTransactionOptions	of(@Nullable TransactionOptions options)	Factory method to wrap given MongoDB driver native TransactionOptions into MongoTransactionOptions.
default @Nullable TransactionOptions	toDriverOptions()

Methods inherited from interface ReadConcernAware

getReadConcern, hasReadConcern

Methods inherited from interface ReadPreferenceAware

getReadPreference, hasReadPreference

Methods inherited from interface TransactionMetadata

getMaxCommitTime, hasMaxCommitTime

Methods inherited from interface WriteConcernAware

getWriteConcern, hasWriteConcern

Field Details

NONE

static final MongoTransactionOptions NONE

Value Object representing empty options enforcing client defaults. Returns null for all getter methods.

Method Details

mergeWith

@Contract("null -> this")
default MongoTransactionOptions mergeWith(@Nullable MongoTransactionOptions fallbackOptions)

Merge current options with given ones. Will return first non null value from getters whereas the this has precedence over the given fallbackOptions.

Parameters:

fallbackOptions - can be null.

Returns:

new instance of MongoTransactionOptions or this if fallbackOptions is null or NONE.

map

default <T> T map(Function<MongoTransactionOptions, T> mappingFunction)

Apply the current options using the given mapping Function and return its result.

Parameters:

mappingFunction -

Returns:

result of the mapping function.

toDriverOptions

default @Nullable TransactionOptions toDriverOptions()

Returns:

MongoDB driver native TransactionOptions.

See Also:

• map(Function)

of

static MongoTransactionOptions of(@Nullable TransactionOptions options)

Factory method to wrap given MongoDB driver native TransactionOptions into MongoTransactionOptions.

Parameters:

options - can be null.

Returns:

NONE if given object is null.