forked from mongodb/mongo-java-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBulkWriteResult.java
More file actions
109 lines (98 loc) · 4.09 KB
/
Copy pathBulkWriteResult.java
File metadata and controls
109 lines (98 loc) · 4.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
* Copyright (c) 2008-2014 MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb;
import java.util.List;
/**
* The result of a successful bulk write operation.
*
* @since 2.12
*/
public abstract class BulkWriteResult {
/**
* Returns true if the write was acknowledged.
*
* @return true if the write was acknowledged
* @see WriteConcern#UNACKNOWLEDGED
*/
public abstract boolean isAcknowledged();
/**
* Returns the number of documents inserted by the write operation.
*
* @return the number of documents inserted by the write operation
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @see WriteConcern#UNACKNOWLEDGED
*/
public abstract int getInsertedCount();
/**
* Returns the number of documents matched by updates or replacements in the write operation. This will include documents that
* matched the query but where the modification didn't result in any actual change to the document; for example,
* if you set the value of some field, and the field already has that value, that will still count as an update.
*
* @return the number of documents matched by updates in the write operation
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @see WriteConcern#UNACKNOWLEDGED
*/
public abstract int getMatchedCount();
/**
* Returns the number of documents removed by the write operation.
*
* @return the number of documents removed by the write operation
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @see WriteConcern#UNACKNOWLEDGED
*/
public abstract int getRemovedCount();
/**
* Returns true if the server was able to provide a count of modified documents. If this method returns false (which can happen if
* the server is not at least version 2.6) then the {@code getModifiedCount} method will throw {@code UnsupportedOperationException}.
*
* @return true if modifiedCount is available
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @see WriteConcern#UNACKNOWLEDGED
* @see #getModifiedCount()
*/
public abstract boolean isModifiedCountAvailable();
/**
* Returns the number of documents modified by updates or replacements in the write operation. This will only count documents that
* were actually changed; for example, if you set the value of some field, and the field already has that value,
* that will not count as a modification.
* <p>
* If the server is not able to provide a count of modified documents (which can happen if the server is not at least version
* 2.6), then this method will throw an {@code UnsupportedOperationException}
* </p>
*
* @return the number of documents modified by the write operation
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @throws java.lang.UnsupportedOperationException if no modified count is available
* @see WriteConcern#UNACKNOWLEDGED
* @see #isModifiedCountAvailable()
* @mongodb.server.release 2.6
*/
public abstract int getModifiedCount();
/**
* Gets an unmodifiable list of upserted items, or the empty list if there were none.
*
* @return a list of upserted items, or the empty list if there were none.
*
* @throws UnacknowledgedWriteException if the write was unacknowledged.
* @see WriteConcern#UNACKNOWLEDGED
*/
public abstract List<BulkWriteUpsert> getUpserts();
}