public abstract class FieldValue extends Object
Modifier and Type | Method and Description |
---|---|
static FieldValue |
arrayRemove(Object... 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.
|
static FieldValue |
arrayUnion(Object... elements)
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.
|
static FieldValue |
delete()
Returns a sentinel used with update() to mark a field for deletion.
|
boolean |
equals(Object obj)
Returns true if this FieldValue is equal to the provided object.
|
int |
hashCode() |
static FieldValue |
increment(double d)
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.
|
static FieldValue |
increment(long 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.
|
static FieldValue |
serverTimestamp()
Returns a sentinel used with set() or update() to include a server-generated timestamp in the
written data.
|
@Nonnull public static FieldValue serverTimestamp()
@Nonnull public static FieldValue delete()
@Nonnull public static FieldValue increment(long l)
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.
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.
@Nonnull public static FieldValue increment(double d)
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.
@Nonnull public static FieldValue arrayUnion(@Nonnull Object... elements)
elements
- The elements to union into the array.@Nonnull public static FieldValue arrayRemove(@Nonnull Object... elements)
elements
- The elements to remove from the array.public boolean equals(Object obj)
Copyright © 2019 Google LLC. All rights reserved.