Skip to content

Commit b4335d7

Browse files
committed
Polishing.
Refine Javadoc and test member visibility. See #5045
1 parent d748500 commit b4335d7

File tree

2 files changed

+69
-70
lines changed
  • spring-data-mongodb/src

2 files changed

+69
-70
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Update.java

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public static Update fromDocument(Document object, String... exclude) {
107107
}
108108

109109
/**
110-
* Update using the {@literal $set} update modifier
110+
* Update using the {@literal $set} update modifier.
111111
*
112112
* @param key the field name.
113113
* @param value can be {@literal null}. In this case the property remains in the db with a {@literal null} value. To
@@ -122,7 +122,7 @@ public Update set(String key, @Nullable Object value) {
122122
}
123123

124124
/**
125-
* Update using the {@literal $setOnInsert} update modifier
125+
* Update using the {@literal $setOnInsert} update modifier.
126126
*
127127
* @param key the field name.
128128
* @param value can be {@literal null}.
@@ -137,7 +137,7 @@ public Update setOnInsert(String key, @Nullable Object value) {
137137
}
138138

139139
/**
140-
* Update using the {@literal $unset} update modifier
140+
* Update using the {@literal $unset} update modifier.
141141
*
142142
* @param key the field name.
143143
* @return this.
@@ -191,9 +191,8 @@ public Update push(String key, @Nullable Object value) {
191191
}
192192

193193
/**
194-
* Update using {@code $push} modifier. <br/>
195-
* Allows creation of {@code $push} command for single or multiple (using {@code $each}) values as well as using
196-
* {@code $position}.
194+
* Update using {@code $push} modifier. Allows creation of {@code $push} command for single or multiple (using
195+
* {@code $each}) values as well as using {@code $position}.
197196
*
198197
* @param key the field name.
199198
* @return {@link PushOperatorBuilder} for given key
@@ -214,8 +213,8 @@ public PushOperatorBuilder push(String key) {
214213
}
215214

216215
/**
217-
* Update using {@code $addToSet} modifier. <br/>
218-
* Allows creation of {@code $push} command for single or multiple (using {@code $each}) values
216+
* Update using {@code $addToSet} modifier. Allows creation of {@code $push} command for single or multiple (using
217+
* {@code $each}) values
219218
*
220219
* @param key the field name.
221220
* @return new instance of {@link AddToSetBuilder}.
@@ -227,7 +226,7 @@ public AddToSetBuilder addToSet(String key) {
227226
}
228227

229228
/**
230-
* Update using the {@literal $addToSet} update modifier
229+
* Update using the {@literal $addToSet} update modifier.
231230
*
232231
* @param key the field name.
233232
* @param value can be {@literal null}.
@@ -242,7 +241,7 @@ public Update addToSet(String key, @Nullable Object value) {
242241
}
243242

244243
/**
245-
* Update using the {@literal $pop} update modifier
244+
* Update using the {@literal $pop} update modifier.
246245
*
247246
* @param key the field name.
248247
* @param pos must not be {@literal null}.
@@ -256,7 +255,7 @@ public Update pop(String key, Position pos) {
256255
}
257256

258257
/**
259-
* Update using the {@literal $pull} update modifier
258+
* Update using the {@literal $pull} update modifier.
260259
*
261260
* @param key the field name.
262261
* @param value can be {@literal null}.
@@ -270,7 +269,7 @@ public Update pull(String key, @Nullable Object value) {
270269
}
271270

272271
/**
273-
* Update using the {@literal $pullAll} update modifier
272+
* Update using the {@literal $pullAll} update modifier.
274273
*
275274
* @param key the field name.
276275
* @param values must not be {@literal null}.
@@ -285,7 +284,7 @@ public Update pullAll(String key, Object[] values) {
285284
}
286285

287286
/**
288-
* Update using the {@literal $rename} update modifier
287+
* Update using the {@literal $rename} update modifier.
289288
*
290289
* @param oldName must not be {@literal null}.
291290
* @param newName must not be {@literal null}.
@@ -398,8 +397,8 @@ public BitwiseOperatorBuilder bitwise(String key) {
398397

399398
/**
400399
* Prevents a write operation that affects <strong>multiple</strong> documents from yielding to other reads or writes
401-
* once the first document is written. <br />
402-
* Use with {@link org.springframework.data.mongodb.core.MongoOperations#updateMulti(Query, UpdateDefinition, Class)}.
400+
* once the first document is written. Use with
401+
* {@link org.springframework.data.mongodb.core.MongoOperations#updateMulti(Query, UpdateDefinition, Class)}.
403402
*
404403
* @return this.
405404
* @since 2.0

0 commit comments

Comments
 (0)