Package com.mongodb.client.result

Class UpdateResult

java.lang.Object

com.mongodb.client.result.UpdateResult

public abstract class UpdateResult
extends Object

The result of an update operation. If the update was unacknowledged, then wasAcknowledged will return false and all other methods will throw UnsupportedOperationException.

Since:

3.0

See Also:

WriteConcern.UNACKNOWLEDGED

Constructor Summary

Constructors

Constructor	Description
UpdateResult()

Method Summary

Modifier and Type	Method	Description
static UpdateResult	acknowledged(long matchedCount, Long modifiedCount, BsonValue upsertedId)	Create an acknowledged UpdateResult
abstract long	getMatchedCount()	Gets the number of documents matched by the query.
abstract long	getModifiedCount()	Gets the number of documents modified by the update.
abstract BsonValue	getUpsertedId()	If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null.
abstract boolean	isModifiedCountAvailable()	Gets a value indicating whether the modified count is available.
static UpdateResult	unacknowledged()	Create an unacknowledged UpdateResult
abstract boolean	wasAcknowledged()	Returns true if the write was acknowledged.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateResult

public UpdateResult()

Method Detail

wasAcknowledged

public abstract boolean wasAcknowledged()

Returns true if the write was acknowledged.

Returns:

true if the write was acknowledged

getMatchedCount

public abstract long getMatchedCount()

Gets the number of documents matched by the query.

Returns:

the number of documents matched

isModifiedCountAvailable

public abstract boolean isModifiedCountAvailable()

Gets a value indicating whether the modified count is available.

The modified count is only available when all servers have been upgraded to 2.6 or above.

Returns:

true if the modified count is available

getModifiedCount

public abstract long getModifiedCount()

Gets the number of documents modified by the update.

Returns:

the number of documents modified

getUpsertedId

@Nullable
public abstract BsonValue getUpsertedId()

If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null.

Returns:

if the replace resulted in an inserted document, the _id of the inserted document, otherwise null

acknowledged

public static UpdateResult acknowledged(long matchedCount,
                                        @Nullable
                                        Long modifiedCount,
                                        @Nullable
                                        BsonValue upsertedId)

Create an acknowledged UpdateResult

Parameters:

matchedCount - the number of documents matched

modifiedCount - the number of documents modified

upsertedId - if the replace resulted in an inserted document, the id of the inserted document

Returns:

an acknowledged UpdateResult

unacknowledged

public static UpdateResult unacknowledged()

Create an unacknowledged UpdateResult

Returns:

an unacknowledged UpdateResult