-
Notifications
You must be signed in to change notification settings - Fork 63
/
FieldValue.java
499 lines (427 loc) · 14.9 KB
/
FieldValue.java
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/*
* Copyright 2017 Google LLC
*
* 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.google.cloud.firestore;
import com.google.common.base.Preconditions;
import com.google.firestore.v1.ArrayValue;
import com.google.firestore.v1.DocumentTransform.FieldTransform;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nonnull;
/** Sentinel values that can be used when writing document fields with set() or update(). */
public abstract class FieldValue {
private static final FieldValue SERVER_TIMESTAMP_SENTINEL =
new FieldValue() {
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.serverTimestamp()";
}
@Override
FieldTransform toProto(FieldPath path) {
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setSetToServerValue(FieldTransform.ServerValue.REQUEST_TIME);
return fieldTransform.build();
}
};
static final FieldValue DELETE_SENTINEL =
new FieldValue() {
@Override
boolean includeInDocumentMask() {
return true;
}
@Override
boolean includeInDocumentTransform() {
return false;
}
@Override
String getMethodName() {
return "FieldValue.delete()";
}
@Override
FieldTransform toProto(FieldPath path) {
throw new IllegalStateException(
"FieldValue.delete() should not be included in a FieldTransform");
}
};
static class NumericIncrementFieldValue extends FieldValue {
final Number operand;
NumericIncrementFieldValue(Number operand) {
this.operand = operand;
}
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.increment()";
}
@Override
FieldTransform toProto(FieldPath path) {
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setIncrement(
UserDataConverter.encodeValue(path, operand, UserDataConverter.ARGUMENT));
return fieldTransform.build();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
NumericIncrementFieldValue that = (NumericIncrementFieldValue) o;
return Objects.equals(operand, that.operand);
}
@Override
public int hashCode() {
return Objects.hash(operand);
}
}
static class NumericMaximumFieldValue extends FieldValue {
final Number operand;
NumericMaximumFieldValue(Number operand) {
this.operand = operand;
}
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.maximum()";
}
@Override
FieldTransform toProto(FieldPath path) {
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setMaximum(
UserDataConverter.encodeValue(path, operand, UserDataConverter.ARGUMENT));
return fieldTransform.build();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
NumericMaximumFieldValue that = (NumericMaximumFieldValue) o;
return Objects.equals(operand, that.operand);
}
@Override
public int hashCode() {
return Objects.hash(operand);
}
}
static class NumericMinimumFieldValue extends FieldValue {
final Number operand;
NumericMinimumFieldValue(Number operand) {
this.operand = operand;
}
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.minimum()";
}
@Override
FieldTransform toProto(FieldPath path) {
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setMinimum(
UserDataConverter.encodeValue(path, operand, UserDataConverter.ARGUMENT));
return fieldTransform.build();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
NumericMinimumFieldValue that = (NumericMinimumFieldValue) o;
return Objects.equals(operand, that.operand);
}
@Override
public int hashCode() {
return Objects.hash(operand);
}
}
static class ArrayUnionFieldValue extends FieldValue {
final List<Object> elements;
ArrayUnionFieldValue(List<Object> elements) {
this.elements = elements;
}
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.arrayUnion()";
}
@Override
FieldTransform toProto(FieldPath path) {
ArrayValue.Builder encodedElements = ArrayValue.newBuilder();
for (Object element : elements) {
Object data = CustomClassMapper.convertToPlainJavaTypes(element);
encodedElements.addValues(
UserDataConverter.encodeValue(path, data, UserDataConverter.ARGUMENT));
}
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setAppendMissingElements(encodedElements);
return fieldTransform.build();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ArrayUnionFieldValue that = (ArrayUnionFieldValue) o;
return Objects.equals(elements, that.elements);
}
@Override
public int hashCode() {
return Objects.hash(elements);
}
}
static class ArrayRemoveFieldValue extends FieldValue {
final List<Object> elements;
ArrayRemoveFieldValue(List<Object> elements) {
this.elements = elements;
}
@Override
boolean includeInDocumentMask() {
return false;
}
@Override
boolean includeInDocumentTransform() {
return true;
}
@Override
String getMethodName() {
return "FieldValue.arrayRemove()";
}
@Override
FieldTransform toProto(FieldPath path) {
ArrayValue.Builder encodedElements = ArrayValue.newBuilder();
for (Object element : elements) {
Object data = CustomClassMapper.convertToPlainJavaTypes(element);
encodedElements.addValues(
UserDataConverter.encodeValue(path, data, UserDataConverter.ARGUMENT));
}
FieldTransform.Builder fieldTransform = FieldTransform.newBuilder();
fieldTransform.setFieldPath(path.getEncodedPath());
fieldTransform.setRemoveAllFromArray(encodedElements);
return fieldTransform.build();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ArrayRemoveFieldValue that = (ArrayRemoveFieldValue) o;
return Objects.equals(elements, that.elements);
}
@Override
public int hashCode() {
return Objects.hash(elements);
}
}
private FieldValue() {}
/**
* Returns a sentinel used with set() or update() to include a server-generated timestamp in the
* written data.
*/
@Nonnull
public static FieldValue serverTimestamp() {
return SERVER_TIMESTAMP_SENTINEL;
}
/** Returns a sentinel used with update() to mark a field for deletion. */
@Nonnull
public static FieldValue delete() {
return DELETE_SENTINEL;
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to increment the field's current value by the given value.
*
* <p>If the current field value is an integer, possible integer overflows are resolved to
* Long.MAX_VALUE or Long.MIN_VALUE. If the current field value is a double, both values will be
* interpreted as doubles and the arithmetic will follow IEEE 754 semantics.
*
* <p>If the current field is not an integer or double, or if the field does not yet exist, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue increment(long l) {
return new NumericIncrementFieldValue(l);
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to increment the field's current value by the given value.
*
* <p>If the current value is an integer or a double, both the current and the given value will be
* interpreted as doubles and all arithmetic will follow IEEE 754 semantics. Otherwise, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue increment(double d) {
return new NumericIncrementFieldValue(d);
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to take the maximum of the field's current value and the given value.
*
* <p>If the current field is not an integer or double, or if the field does not yet exist, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue maximum(long l) { return new NumericMaximumFieldValue(l); }
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to take the maximum of the field's current value and the given value.
*
* <p>If the current field is not an integer or double, or if the field does not yet exist, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue maximum(double d) {
return new NumericMaximumFieldValue(d);
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to take the minimum of the field's current value and the given value.
*
* <p>If the current field is not an integer or double, or if the field does not yet exist, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue minimum(long l) { return new NumericMinimumFieldValue(l); }
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to take the minimum of the field's current value and the given value.
*
* <p>If the current field is not an integer or double, or if the field does not yet exist, the
* transformation will set the field to the given value.
*
* @return The FieldValue sentinel for use in a call to set(), create() or update().
*/
@Nonnull
public static FieldValue minimum(double d) {
return new NumericMinimumFieldValue(d);
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to union the given elements with any array value that already exists on the server. Each
* specified element that doesn't already exist in the array will be added to the end. If the
* field being modified is not already an array it will be overwritten with an array containing
* exactly the specified elements.
*
* @param elements The elements to union into the array.
* @return The FieldValue sentinel for use in a call to set() or update().
*/
@Nonnull
public static FieldValue arrayUnion(@Nonnull Object... elements) {
Preconditions.checkArgument(elements.length > 0, "arrayUnion() expects at least 1 element");
return new ArrayUnionFieldValue(Arrays.asList(elements));
}
/**
* Returns a special value that can be used with set(), create() or update() that tells the server
* to remove the given elements from any array value that already exists on the server. All
* instances of each element specified will be removed from the array. If the field being modified
* is not already an array it will be overwritten with an empty array.
*
* @param elements The elements to remove from the array.
* @return The FieldValue sentinel for use in a call to set() or update().
*/
@Nonnull
public static FieldValue arrayRemove(@Nonnull Object... elements) {
Preconditions.checkArgument(elements.length > 0, "arrayRemove() expects at least 1 element");
return new ArrayRemoveFieldValue(Arrays.asList(elements));
}
/** Whether this FieldTransform should be included in the document mask. */
abstract boolean includeInDocumentMask();
/** Whether this FieldTransform should be included in the list of document transforms. */
abstract boolean includeInDocumentTransform();
/** The name of the method that returned this FieldValue instance. */
abstract String getMethodName();
/** Generates the field transform proto. */
abstract FieldTransform toProto(FieldPath path);
/**
* Returns true if this FieldValue is equal to the provided object.
*
* @param obj The object to compare against.
* @return Whether this FieldValue is equal to the provided object.
*/
@Override
public boolean equals(Object obj) {
return this == obj;
}
@Override
public int hashCode() {
return super.hashCode();
}
}