org.ojai

Interface Document

All Superinterfaces:

Container, Iterable<Map.Entry<String,Value>>, JsonString

All Known Implementing Classes:

DocumentBase

@API.Public
 @API.NotThreadSafe
public interface Document
extends Iterable<Map.Entry<String,Value>>, Container, JsonString

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap()
DocumentReader	asReader()
DocumentReader	asReader(FieldPath fieldPath)
DocumentReader	asReader(String fieldPath)
Document	delete(FieldPath fieldPath) Deletes the value at the specified FieldPath if it exists.
Document	delete(String fieldPath) Deletes the value at the specified FieldPath if it exists.
Document	empty() Removes all of the entries from this document.
ByteBuffer	getBinary(FieldPath fieldPath) Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document.
ByteBuffer	getBinary(String fieldPath) Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document.
boolean	getBoolean(FieldPath fieldPath) Returns the value at the specified fieldPath as a boolean.
boolean	getBoolean(String fieldPath) Returns the value at the specified fieldPath as a boolean.
Boolean	getBooleanObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.
Boolean	getBooleanObj(String fieldPath) Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.
byte	getByte(FieldPath fieldPath) Returns the value at the specified fieldPath as a byte.
byte	getByte(String fieldPath) Returns the value at the specified fieldPath as a byte.
Byte	getByteObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.
Byte	getByteObj(String fieldPath) Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.
ODate	getDate(FieldPath fieldPath) Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document.
ODate	getDate(String fieldPath) Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document.
BigDecimal	getDecimal(FieldPath fieldPath) Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document.
BigDecimal	getDecimal(String fieldPath) Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document.
double	getDouble(FieldPath fieldPath) Returns the value at the specified fieldPath as a double.
double	getDouble(String fieldPath) Returns the value at the specified fieldPath as a double.
Double	getDoubleObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.
Double	getDoubleObj(String fieldPath) Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.
float	getFloat(FieldPath fieldPath) Returns the value at the specified fieldPath as a float.
float	getFloat(String fieldPath) Returns the value at the specified fieldPath as a float.
Float	getFloatObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.
Float	getFloatObj(String fieldPath) Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.
Value	getId()
ByteBuffer	getIdBinary()
String	getIdString()
int	getInt(FieldPath fieldPath) Returns the value at the specified fieldPath as an int.
int	getInt(String fieldPath) Returns the value at the specified fieldPath as an int.
OInterval	getInterval(FieldPath fieldPath) Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document.
OInterval	getInterval(String fieldPath) Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document.
Integer	getIntObj(FieldPath fieldPath) Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.
Integer	getIntObj(String fieldPath) Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.
List<Object>	getList(FieldPath fieldPath) Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.
List<Object>	getList(String fieldPath) Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.
long	getLong(FieldPath fieldPath) Returns the value at the specified fieldPath as a long.
long	getLong(String fieldPath) Returns the value at the specified fieldPath as a long.
Long	getLongObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.
Long	getLongObj(String fieldPath) Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.
Map<String,Object>	getMap(FieldPath fieldPath) Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document.
Map<String,Object>	getMap(String fieldPath) Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document.
short	getShort(FieldPath fieldPath) Returns the value at the specified fieldPath as a short.
short	getShort(String fieldPath) Returns the value at the specified fieldPath as a short.
Short	getShortObj(FieldPath fieldPath) Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.
Short	getShortObj(String fieldPath) Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.
String	getString(FieldPath fieldPath) Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.
String	getString(String fieldPath) Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.
OTime	getTime(FieldPath fieldPath) Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document.
OTime	getTime(String fieldPath) Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document.
OTimestamp	getTimestamp(FieldPath fieldPath) Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document.
OTimestamp	getTimestamp(String fieldPath) Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document.
Value	getValue(FieldPath fieldPath) Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document.
Value	getValue(String fieldPath) Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document.
boolean	isReadOnly() Returns true if this Document does not support any write operations like set/delete etc.
Document	set(FieldPath fieldPath, BigDecimal value) Sets the value of the specified fieldPath in this Document to the specified BigDecimal.
Document	set(FieldPath fieldPath, boolean value) Sets the value of the specified fieldPath in this Document to the specified boolean value.
Document	set(FieldPath fieldPath, byte value) Sets the value of the specified fieldPath in this Document to the specified byte value.
Document	set(FieldPath fieldPath, byte[] value) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(FieldPath fieldPath, byte[] value, int off, int len) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(FieldPath fieldPath, ByteBuffer value) Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.
Document	set(FieldPath fieldPath, Document value) Sets the value of the specified fieldPath in this Document to the specified Document.
Document	set(FieldPath fieldPath, double value) Sets the value of the specified fieldPath in this Document to the specified double value.
Document	set(FieldPath fieldPath, float value) Sets the value of the specified fieldPath in this Document to the specified float value.
Document	set(FieldPath fieldPath, int value) Sets the value of the specified fieldPath in this Document to the specified int value.
Document	set(FieldPath fieldPath, List<? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Object List.
Document	set(FieldPath fieldPath, long value) Sets the value of the specified fieldPath in this Document to the specified long value.
Document	set(FieldPath fieldPath, Map<String,? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Map.
Document	set(FieldPath fieldPath, ODate value) Sets the value of the specified fieldPath in this Document to the specified Date.
Document	set(FieldPath fieldPath, OInterval value) Sets the value of the specified fieldPath in this Document to the specified Interval.
Document	set(FieldPath fieldPath, OTime value) Sets the value of the specified fieldPath in this Document to the specified Time.
Document	set(FieldPath fieldPath, OTimestamp value) Sets the value of the specified fieldPath in this Document to the specified Timestamp.
Document	set(FieldPath fieldPath, short value) Sets the value of the specified fieldPath in this Document to the specified short value.
Document	set(FieldPath fieldPath, String value) Sets the value of the specified fieldPath in this Document to the specified String.
Document	set(FieldPath fieldPath, Value value) Sets the value of the specified fieldPath in this Document to the specified Value.
Document	set(String fieldPath, BigDecimal value) Sets the value of the specified fieldPath in this Document to the specified BigDecimal.
Document	set(String fieldPath, boolean value) Sets the value of the specified fieldPath in this Document to the specified boolean value.
Document	set(String fieldPath, byte value) Sets the value of the specified fieldPath in this Document to the specified byte value.
Document	set(String fieldPath, byte[] value) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(String fieldPath, byte[] value, int off, int len) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(String fieldPath, ByteBuffer value) Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.
Document	set(String fieldPath, Document value) Sets the value of the specified fieldPath in this Document to the specified Document.
Document	set(String fieldPath, double value) Sets the value of the specified fieldPath in this Document to the specified double value.
Document	set(String fieldPath, float value) Sets the value of the specified fieldPath in this Document to the specified float value.
Document	set(String fieldPath, int value) Sets the value of the specified fieldPath in this Document to the specified int value.
Document	set(String fieldPath, List<? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Object List.
Document	set(String fieldPath, long value) Sets the value of the specified fieldPath in this Document to the specified long value.
Document	set(String fieldPath, Map<String,? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Map.
Document	set(String fieldPath, ODate value) Sets the value of the specified fieldPath in this Document to the specified Date.
Document	set(String fieldPath, OInterval value) Sets the value of the specified fieldPath in this Document to the specified Interval.
Document	set(String fieldPath, OTime value) Sets the value of the specified fieldPath in this Document to the specified Time.
Document	set(String fieldPath, OTimestamp value) Sets the value of the specified fieldPath in this Document to the specified Timestamp.
Document	set(String fieldPath, short value) Sets the value of the specified fieldPath in this Document to the specified short value.
Document	set(String fieldPath, String value) Sets the value of the specified fieldPath in this Document to the specified String.
Document	set(String fieldPath, Value value) Sets the value of the specified fieldPath in this Document to the specified Value.
Document	setArray(FieldPath fieldPath, boolean[] values) Sets the value of the specified fieldPath in this Document to the specified boolean array.
Document	setArray(FieldPath fieldPath, byte[] values) Sets the value of the specified fieldPath in this Document to the specified byte array.
Document	setArray(FieldPath fieldPath, double[] values) Sets the value of the specified fieldPath in this Document to the specified double array.
Document	setArray(FieldPath fieldPath, float[] values) Sets the value of the specified fieldPath in this Document to the specified float array.
Document	setArray(FieldPath fieldPath, int[] values) Sets the value of the specified fieldPath in this Document to the specified int array.
Document	setArray(FieldPath fieldPath, long[] values) Sets the value of the specified fieldPath in this Document to the specified long array.
Document	setArray(FieldPath fieldPath, Object... values) Sets the value of the specified fieldPath in this Document to the specified Object array.
Document	setArray(FieldPath fieldPath, short[] values) Sets the value of the specified fieldPath in this Document to the specified short array.
Document	setArray(FieldPath fieldPath, String[] values) Sets the value of the specified fieldPath in this Document to the specified String array.
Document	setArray(String fieldPath, boolean[] values) Sets the value of the specified fieldPath in this Document to the specified boolean array.
Document	setArray(String fieldPath, byte[] values) Sets the value of the specified fieldPath in this Document to the specified byte array.
Document	setArray(String fieldPath, double[] values) Sets the value of the specified fieldPath in this Document to the specified double array.
Document	setArray(String fieldPath, float[] values) Sets the value of the specified fieldPath in this Document to the specified float array.
Document	setArray(String fieldPath, int[] values) Sets the value of the specified fieldPath in this Document to the specified int array.
Document	setArray(String fieldPath, long[] values) Sets the value of the specified fieldPath in this Document to the specified long array.
Document	setArray(String fieldPath, Object... values) Sets the value of the specified fieldPath in this Document to the specified Object array.
Document	setArray(String fieldPath, short[] values) Sets the value of the specified fieldPath in this Document to the specified short array.
Document	setArray(String fieldPath, String[] values) Sets the value of the specified fieldPath in this Document to the specified String array.
Document	setId(ByteBuffer _id) Sets the "_id" field of this Document to the specified string.
Document	setId(String _id) Sets the the "_id" field of this Document to the specified string.
Document	setId(Value _id) Sets the the "_id" field of this Document to the specified Value.
Document	setNull(FieldPath fieldPath) Sets the value of the specified fieldPath in this Document to Value.Type.NULL.
Document	setNull(String fieldPath) Sets the value of the specified fieldPath in this Document to Value.Type.NULL.
int	size()
<T> T	toJavaBean(Class<T> beanClass) Converts this Document to an instance of the specified class.
String	toString()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.ojai.Container

isEmpty

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Method Detail

setId

Document setId(@API.NonNullable
               Value _id)

Sets the the "_id" field of this Document to the specified Value.

Parameters:

_id - Value to set as the value of "_id" field

Returns:

this for chaining

getId

Value getId()

Returns:

the "_id" field of this Document

setId

Document setId(@API.NonNullable
               String _id)

Sets the the "_id" field of this Document to the specified string.

Parameters:

_id - String to set as the value of the "_id" field

Returns:

this for chaining

getIdString

String getIdString()

Returns:

the String _id of this document

Throws:

TypeException - if the _id of this Document is not of the String type

setId

Document setId(@API.NonNullable
               ByteBuffer _id)

Sets the "_id" field of this Document to the specified string.

Parameters:

_id - ByteBuffer to set as the value of "_id" field

Returns:

this for chaining

getIdBinary

ByteBuffer getIdBinary()

Returns:

the binary _id of this document

Throws:

TypeException - if the _id of this Document is not of the BINARY type

isReadOnly

boolean isReadOnly()

Returns true if this Document does not support any write operations like set/delete etc.

Specified by:

isReadOnly in interface Container

size

int size()

Specified by:

size in interface Container

Returns:

the number of top level entries in the document.

toJavaBean

<T> T toJavaBean(@API.NonNullable
                 Class<T> beanClass)
          throws DecodingException

Converts this Document to an instance of the specified class.

Parameters:

beanClass - the class of instance

Returns:

an instance of the specified class converted from this Document

Throws:

DecodingException

empty

Document empty()

Removes all of the entries from this document.

Specified by:

empty in interface Container

Returns:

this for chaining.

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             String value)

Sets the value of the specified fieldPath in this Document to the specified String.

Parameters:

fieldPath - the FieldPath to set

value - the String value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             String value)

Sets the value of the specified fieldPath in this Document to the specified String.

Parameters:

fieldPath - the FieldPath to set

value - the String value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             boolean value)

Sets the value of the specified fieldPath in this Document to the specified boolean value.

Parameters:

fieldPath - the FieldPath to set

value - the boolean value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             boolean value)

Sets the value of the specified fieldPath in this Document to the specified boolean value.

Parameters:

fieldPath - the FieldPath to set

value - the boolean value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             byte value)

Sets the value of the specified fieldPath in this Document to the specified byte value.

Parameters:

fieldPath - the FieldPath to set

value - the byte value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             byte value)

Sets the value of the specified fieldPath in this Document to the specified byte value.

Parameters:

fieldPath - the FieldPath to set

value - the byte value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             short value)

Sets the value of the specified fieldPath in this Document to the specified short value.

Parameters:

fieldPath - the FieldPath to set

value - the short value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             short value)

Sets the value of the specified fieldPath in this Document to the specified short value.

Parameters:

fieldPath - the FieldPath to set

value - the short value

Returns:

this for chaining.

set

Document set(@API.NonNullable
             String fieldPath,
             int value)

Sets the value of the specified fieldPath in this Document to the specified int value.

Parameters:

fieldPath - the FieldPath to set

value - the int value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             int value)

Sets the value of the specified fieldPath in this Document to the specified int value.

Parameters:

fieldPath - the FieldPath to set

value - the int value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             long value)

Sets the value of the specified fieldPath in this Document to the specified long value.

Parameters:

fieldPath - the FieldPath to set

value - the long value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             long value)

Sets the value of the specified fieldPath in this Document to the specified long value.

Parameters:

fieldPath - the FieldPath to set

value - the long value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             float value)

Sets the value of the specified fieldPath in this Document to the specified float value.

Parameters:

fieldPath - the FieldPath to set

value - the float value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             float value)

Sets the value of the specified fieldPath in this Document to the specified float value.

Parameters:

fieldPath - the FieldPath to set

value - the float value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             double value)

Sets the value of the specified fieldPath in this Document to the specified double value.

Parameters:

fieldPath - the FieldPath to set

value - the double value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             double value)

Sets the value of the specified fieldPath in this Document to the specified double value.

Parameters:

fieldPath - the FieldPath to set

value - the double value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             BigDecimal value)

Sets the value of the specified fieldPath in this Document to the specified BigDecimal.

Parameters:

fieldPath - the FieldPath to set

value - the BigDecimal value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             BigDecimal value)

Sets the value of the specified fieldPath in this Document to the specified BigDecimal.

Parameters:

fieldPath - the FieldPath to set

value - the BigDecimal value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             OTime value)

Sets the value of the specified fieldPath in this Document to the specified Time.

Parameters:

fieldPath - the FieldPath to set

value - the Time value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             OTime value)

Sets the value of the specified fieldPath in this Document to the specified Time.

Parameters:

fieldPath - the FieldPath to set

value - the Time value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             ODate value)

Sets the value of the specified fieldPath in this Document to the specified Date.

Parameters:

fieldPath - the FieldPath to set

value - the Date value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             ODate value)

Sets the value of the specified fieldPath in this Document to the specified Date.

Parameters:

fieldPath - the FieldPath to set

value - the Date value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             OTimestamp value)

Sets the value of the specified fieldPath in this Document to the specified Timestamp.

Parameters:

fieldPath - the FieldPath to set

value - the Timestamp value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             OTimestamp value)

Sets the value of the specified fieldPath in this Document to the specified Timestamp.

Parameters:

fieldPath - the FieldPath to set

value - the Timestamp value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             OInterval value)

Sets the value of the specified fieldPath in this Document to the specified Interval.

Parameters:

fieldPath - the FieldPath to set

value - the Interval value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             OInterval value)

Sets the value of the specified fieldPath in this Document to the specified Interval.

Parameters:

fieldPath - the FieldPath to set

value - the Interval value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             byte[] value)

Sets the value of the specified fieldPath in this Document to the specified binary value.

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             byte[] value)

Sets the value of the specified fieldPath in this Document to the specified binary value.

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             byte[] value,
             int off,
             int len)

Sets the value of the specified fieldPath in this Document to the specified binary value.

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             byte[] value,
             int off,
             int len)

Sets the value of the specified fieldPath in this Document to the specified binary value.

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             ByteBuffer value)

Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.

Parameters:

fieldPath - the FieldPath to set

value - the ByteBuffer

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             ByteBuffer value)

Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.

Parameters:

fieldPath - the FieldPath to set

value - the ByteBuffer

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             Map<String,? extends Object> value)

Sets the value of the specified fieldPath in this Document to the specified Map.

Parameters:

fieldPath - the FieldPath to set

value - the Map value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             Map<String,? extends Object> value)

Sets the value of the specified fieldPath in this Document to the specified Map.

Parameters:

fieldPath - the FieldPath to set

value - the Map value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             Document value)

Sets the value of the specified fieldPath in this Document to the specified Document. Recursive set such as set("a", doc) followed by set("a.b", doc) is undefined.

Parameters:

fieldPath - the FieldPath to set

value - the Document

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             Document value)

Sets the value of the specified fieldPath in this Document to the specified Document. Recursive set such as set("a", doc) followed by set("a.b", doc) is undefined.

Parameters:

fieldPath - the FieldPath to set

value - the Document

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             Value value)

Sets the value of the specified fieldPath in this Document to the specified Value.

Parameters:

fieldPath - the FieldPath to set

value - the Value

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             Value value)

Sets the value of the specified fieldPath in this Document to the specified Value.

Parameters:

fieldPath - the FieldPath to set

value - the Value

Returns:

this for chaining

set

Document set(@API.NonNullable
             String fieldPath,
             @API.NonNullable
             List<? extends Object> value)

Sets the value of the specified fieldPath in this Document to the specified Object List.

Parameters:

fieldPath - the FieldPath to set

value - the Object List

Returns:

this for chaining

set

Document set(@API.NonNullable
             FieldPath fieldPath,
             @API.NonNullable
             List<? extends Object> value)

Sets the value of the specified fieldPath in this Document to the specified Object List.

Parameters:

fieldPath - the FieldPath to set

value - the Object List

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  boolean[] values)

Sets the value of the specified fieldPath in this Document to the specified boolean array.

Parameters:

fieldPath - the FieldPath to set

values - the boolean array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  boolean[] values)

Sets the value of the specified fieldPath in this Document to the specified boolean array.

Parameters:

fieldPath - the FieldPath to set

values - the boolean array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  byte[] values)

Sets the value of the specified fieldPath in this Document to the specified byte array.

Parameters:

fieldPath - the FieldPath to set

values - the byte array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  byte[] values)

Sets the value of the specified fieldPath in this Document to the specified byte array.

Parameters:

fieldPath - the FieldPath to set

values - the byte array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  short[] values)

Sets the value of the specified fieldPath in this Document to the specified short array.

Parameters:

fieldPath - the FieldPath to set

values - the short array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  short[] values)

Sets the value of the specified fieldPath in this Document to the specified short array.

Parameters:

fieldPath - the FieldPath to set

values - the short array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  int[] values)

Sets the value of the specified fieldPath in this Document to the specified int array.

Parameters:

fieldPath - the FieldPath to set

values - the int array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  int[] values)

Sets the value of the specified fieldPath in this Document to the specified int array.

Parameters:

fieldPath - the FieldPath to set

values - the int array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  long[] values)

Sets the value of the specified fieldPath in this Document to the specified long array.

Parameters:

fieldPath - the FieldPath to set

values - the long array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  long[] values)

Sets the value of the specified fieldPath in this Document to the specified long array.

Parameters:

fieldPath - the FieldPath to set

values - the long array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  float[] values)

Sets the value of the specified fieldPath in this Document to the specified float array.

Parameters:

fieldPath - the FieldPath to set

values - the float array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  float[] values)

Sets the value of the specified fieldPath in this Document to the specified float array.

Parameters:

fieldPath - the FieldPath to set

values - the float array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  double[] values)

Sets the value of the specified fieldPath in this Document to the specified double array.

Parameters:

fieldPath - the FieldPath to set

values - the double array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  double[] values)

Sets the value of the specified fieldPath in this Document to the specified double array.

Parameters:

fieldPath - the FieldPath to set

values - the double array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  String[] values)

Sets the value of the specified fieldPath in this Document to the specified String array.

Parameters:

fieldPath - the FieldPath to set

values - the String array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  String[] values)

Sets the value of the specified fieldPath in this Document to the specified String array.

Parameters:

fieldPath - the FieldPath to set

values - the String array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  String fieldPath,
                  @API.NonNullable
                  Object... values)

Sets the value of the specified fieldPath in this Document to the specified Object array.

Parameters:

fieldPath - the FieldPath to set

values - the Object array

Returns:

this for chaining

setArray

Document setArray(@API.NonNullable
                  FieldPath fieldPath,
                  @API.NonNullable
                  Object... values)

Sets the value of the specified fieldPath in this Document to the specified Object array.

Parameters:

fieldPath - the FieldPath to set

values - the Object array

Returns:

this for chaining

setNull

Document setNull(@API.NonNullable
                 String fieldPath)

Sets the value of the specified fieldPath in this Document to Value.Type.NULL.

Parameters:

fieldPath - the FieldPath to set

Returns:

this for chaining

setNull

Document setNull(@API.NonNullable
                 FieldPath fieldPath)

Sets the value of the specified fieldPath in this Document to Value.Type.NULL.

Parameters:

fieldPath - the FieldPath to set

Returns:

this for chaining

delete

Document delete(@API.NonNullable
                String fieldPath)

Deletes the value at the specified FieldPath if it exists.

Parameters:

fieldPath - the fieldPath to delete from the document

Returns:

this for chaining

delete

Document delete(@API.NonNullable
                FieldPath fieldPath)

Deletes the value at the specified FieldPath if it exists.

Parameters:

fieldPath - the fieldPath to delete from the document

Returns:

this for chaining

getString

String getString(@API.NonNullable
                 String fieldPath)

Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the STRING type

getString

String getString(@API.NonNullable
                 FieldPath fieldPath)

Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the STRING type

getBoolean

boolean getBoolean(@API.NonNullable
                   String fieldPath)

Returns the value at the specified fieldPath as a boolean.

Throws:

TypeException - if the value at the fieldPath is not of BOOLEAN type

NoSuchElementException - if the specified field does not exist in the Document

getBoolean

boolean getBoolean(@API.NonNullable
                   FieldPath fieldPath)

Returns the value at the specified fieldPath as a boolean.

Throws:

TypeException - if the value at the fieldPath is not of BOOLEAN type

NoSuchElementException - if the specified field does not exist in the Document

getBooleanObj

Boolean getBooleanObj(@API.NonNullable
                      String fieldPath)

Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the BOOLEAN type

getBooleanObj

Boolean getBooleanObj(@API.NonNullable
                      FieldPath fieldPath)

Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the BOOLEAN type

getByte

byte getByte(@API.NonNullable
             String fieldPath)

Returns the value at the specified fieldPath as a byte.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getByte

byte getByte(@API.NonNullable
             FieldPath fieldPath)

Returns the value at the specified fieldPath as a byte.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getByteObj

Byte getByteObj(@API.NonNullable
                String fieldPath)

Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getByteObj

Byte getByteObj(@API.NonNullable
                FieldPath fieldPath)

Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getShort

short getShort(@API.NonNullable
               String fieldPath)

Returns the value at the specified fieldPath as a short.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getShort

short getShort(@API.NonNullable
               FieldPath fieldPath)

Returns the value at the specified fieldPath as a short.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getShortObj

Short getShortObj(@API.NonNullable
                  String fieldPath)

Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getShortObj

Short getShortObj(@API.NonNullable
                  FieldPath fieldPath)

Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getInt

int getInt(@API.NonNullable
           String fieldPath)

Returns the value at the specified fieldPath as an int.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getInt

int getInt(@API.NonNullable
           FieldPath fieldPath)

Returns the value at the specified fieldPath as an int.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getIntObj

Integer getIntObj(@API.NonNullable
                  String fieldPath)

Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getIntObj

Integer getIntObj(@API.NonNullable
                  FieldPath fieldPath)

Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getLong

long getLong(@API.NonNullable
             String fieldPath)

Returns the value at the specified fieldPath as a long.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getLong

long getLong(@API.NonNullable
             FieldPath fieldPath)

Returns the value at the specified fieldPath as a long.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getLongObj

Long getLongObj(@API.NonNullable
                String fieldPath)

Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getLongObj

Long getLongObj(@API.NonNullable
                FieldPath fieldPath)

Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getFloat

float getFloat(@API.NonNullable
               String fieldPath)

Returns the value at the specified fieldPath as a float.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getFloat

float getFloat(@API.NonNullable
               FieldPath fieldPath)

Returns the value at the specified fieldPath as a float.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getFloatObj

Float getFloatObj(@API.NonNullable
                  String fieldPath)

Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getFloatObj

Float getFloatObj(@API.NonNullable
                  FieldPath fieldPath)

Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDouble

double getDouble(@API.NonNullable
                 String fieldPath)

Returns the value at the specified fieldPath as a double.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getDouble

double getDouble(@API.NonNullable
                 FieldPath fieldPath)

Returns the value at the specified fieldPath as a double.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

NoSuchElementException - if the specified field does not exist in the Document

getDoubleObj

Double getDoubleObj(@API.NonNullable
                    String fieldPath)

Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDoubleObj

Double getDoubleObj(@API.NonNullable
                    FieldPath fieldPath)

Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDecimal

BigDecimal getDecimal(@API.NonNullable
                      String fieldPath)

Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDecimal

BigDecimal getDecimal(@API.NonNullable
                      FieldPath fieldPath)

Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getTime

OTime getTime(@API.NonNullable
              String fieldPath)

Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIME type

getTime

OTime getTime(@API.NonNullable
              FieldPath fieldPath)

Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIME type

getDate

ODate getDate(@API.NonNullable
              String fieldPath)

Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the DATE type

getDate

ODate getDate(@API.NonNullable
              FieldPath fieldPath)

Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the DATE type

getTimestamp

OTimestamp getTimestamp(@API.NonNullable
                        String fieldPath)

Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIMESTAMP type

getTimestamp

OTimestamp getTimestamp(@API.NonNullable
                        FieldPath fieldPath)

Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIMESTAMP type

getBinary

ByteBuffer getBinary(@API.NonNullable
                     String fieldPath)

Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the BINARY type

getBinary

ByteBuffer getBinary(@API.NonNullable
                     FieldPath fieldPath)

Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of BINARY type

getInterval

OInterval getInterval(@API.NonNullable
                      String fieldPath)

Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the INTERVAL type

getInterval

OInterval getInterval(@API.NonNullable
                      FieldPath fieldPath)

Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the INTERVAL type

getValue

Value getValue(@API.NonNullable
               String fieldPath)

Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

getValue

Value getValue(@API.NonNullable
               FieldPath fieldPath)

Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

getMap

Map<String,Object> getMap(@API.NonNullable
                          String fieldPath)

Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the MAP type

getMap

Map<String,Object> getMap(@API.NonNullable
                          FieldPath fieldPath)

Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the MAP type

getList

List<Object> getList(@API.NonNullable
                     String fieldPath)

Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the ARRAY type

getList

List<Object> getList(@API.NonNullable
                     FieldPath fieldPath)

Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Throws:

TypeException - if the value at the fieldPath is not of the ARRAY type

toString

String toString()

Overrides:

toString in class Object

Returns:

this Document serialized as Json string using the default options

asReader

DocumentReader asReader()

Returns:

a new DocumentReader over the current document

asReader

DocumentReader asReader(@API.NonNullable
                        String fieldPath)

Returns:

a new DocumentReader over the node specified by the fieldPath or null if the node does not exist

asReader

DocumentReader asReader(@API.NonNullable
                        FieldPath fieldPath)

Returns:

a new DocumentReader over the node specified by the fieldPath or null if the node does not exist

asMap

Map<String,Object> asMap()

Returns:

a new Map representing the Document