Package com.mongodb.operation

Class BaseWriteOperation

java.lang.Object

com.mongodb.operation.BaseWriteOperation

All Implemented Interfaces:

AsyncWriteOperation<WriteConcernResult>, WriteOperation<WriteConcernResult>

Direct Known Subclasses:

DeleteOperation, InsertOperation, UpdateOperation

public abstract class BaseWriteOperation
extends Object
implements AsyncWriteOperation<WriteConcernResult>, WriteOperation<WriteConcernResult>

Abstract base class for write operations.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
BaseWriteOperation(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern)	Deprecated. use BaseWriteOperation(MongoNamespace, boolean, WriteConcern, boolean) instead
BaseWriteOperation(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, boolean retryWrites)	Construct an instance

Method Summary

Modifier and Type	Method	Description
BaseWriteOperation	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
WriteConcernResult	execute(WriteBinding binding)	General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<WriteConcernResult> callback)	General execute which can return anything of type T
Boolean	getBypassDocumentValidation()	Gets the the bypass document level validation flag
MongoNamespace	getNamespace()	Gets the namespace of the collection to write to.
protected abstract WriteRequest.Type	getType()
WriteConcern	getWriteConcern()	Gets the write concern to apply
protected abstract List<? extends WriteRequest>	getWriteRequests()
boolean	isOrdered()	Gets whether the writes are ordered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseWriteOperation

@Deprecated
public BaseWriteOperation(MongoNamespace namespace,
                          boolean ordered,
                          WriteConcern writeConcern)

Deprecated. use BaseWriteOperation(MongoNamespace, boolean, WriteConcern, boolean) instead

Construct an instance

Parameters:

namespace - the database and collection namespace for the operation.

ordered - whether the writes are ordered.

writeConcern - the write concern for the operation.

BaseWriteOperation

public BaseWriteOperation(MongoNamespace namespace,
                          boolean ordered,
                          WriteConcern writeConcern,
                          boolean retryWrites)

Construct an instance

Parameters:

namespace - the database and collection namespace for the operation.

ordered - whether the writes are ordered.

writeConcern - the write concern for the operation.

retryWrites - if writes should be retried if they fail due to a network error.

Since:

3.6

Method Detail

getWriteRequests

protected abstract List<? extends WriteRequest> getWriteRequests()

getType

protected abstract WriteRequest.Type getType()

getNamespace

public MongoNamespace getNamespace()

Gets the namespace of the collection to write to.

Returns:

the namespace

getWriteConcern

public WriteConcern getWriteConcern()

Gets the write concern to apply

Returns:

the write concern

isOrdered

public boolean isOrdered()

Gets whether the writes are ordered. If true, no more writes will be executed after the first failure.

Returns:

whether the writes are ordered

getBypassDocumentValidation

public Boolean getBypassDocumentValidation()

Gets the the bypass document level validation flag

Returns:

the bypass document level validation flag

Since:

3.2

Since server release

3.2

bypassDocumentValidation

public BaseWriteOperation bypassDocumentValidation(Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

Since:

3.2

Since server release

3.2

execute

public WriteConcernResult execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<WriteConcernResult>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<WriteConcernResult> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<WriteConcernResult>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed