Class FieldValue (3.21.0)

public abstract class FieldValue

Sentinel values that can be used when writing document fields with set() or update().

Inheritance

Object > FieldValue

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

arrayRemove(Object[] elements)

public 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. 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.

Parameter
Name	Description
`elements`	`Object[]` The elements to remove from the array.

Returns
Type	Description
`FieldValue`	The FieldValue sentinel for use in a call to set() or update().

arrayUnion(Object[] elements)

public 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. 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.

Parameter
Name	Description
`elements`	`Object[]` The elements to union into the array.

Returns
Type	Description
`FieldValue`	The FieldValue sentinel for use in a call to set() or update().

delete()

public static FieldValue delete()

Returns a sentinel used with update() to mark a field for deletion.

Returns
Type	Description
`FieldValue`

increment(double d)

public 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.

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.

Parameter
Name	Description
`d`	`double`

Returns
Type	Description
`FieldValue`	The FieldValue sentinel for use in a call to set(), create() or update().

increment(long l)

public 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.

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.

Parameter
Name	Description
`l`	`long`

Returns
Type	Description
`FieldValue`	The FieldValue sentinel for use in a call to set(), create() or update().

serverTimestamp()

public static FieldValue serverTimestamp()

Returns a sentinel used with set() or update() to include a server-generated timestamp in the written data.

Returns
Type	Description
`FieldValue`

Methods

equals(Object obj)

public boolean equals(Object obj)

Returns true if this FieldValue is equal to the provided object.

Parameter
Name	Description
`obj`	`Object` The object to compare against.

Returns
Type	Description
`boolean`	Whether this FieldValue is equal to the provided object.

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()