Package org.springframework.data.mongodb

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 com.mongodb.TransactionOptions options)	Factory method to wrap given MongoDB driver native TransactionOptions into MongoTransactionOptions.
default @Nullable com.mongodb.TransactionOptions	toDriverOptions()

Methods inherited from interface org.springframework.data.mongodb.core.ReadConcernAware

getReadConcern, hasReadConcern

Methods inherited from interface org.springframework.data.mongodb.core.ReadPreferenceAware

getReadPreference, hasReadPreference

Methods inherited from interface org.springframework.data.mongodb.TransactionMetadata

getMaxCommitTime, hasMaxCommitTime

Methods inherited from interface org.springframework.data.mongodb.core.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 com.mongodb.TransactionOptions toDriverOptions()

Returns:

MongoDB driver native TransactionOptions.

See Also:

• map(Function)

of

static MongoTransactionOptions of(@Nullable com.mongodb.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.