@API.Public @API.NotThreadSafe public interface Document extends Iterable<Map.Entry<String,Value>>, Container, JsonString
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() |
forEach, iterator, spliterator
asJsonString, asJsonString
Document setId(@API.NonNullable Value _id)
_id
- Value to set as the value of "_id" fieldthis
for chainingValue getId()
Document setId(@API.NonNullable String _id)
_id
- String to set as the value of the "_id" fieldthis
for chainingString getIdString()
TypeException
- if the _id of this Document is not of the String typeDocument setId(@API.NonNullable ByteBuffer _id)
_id
- ByteBuffer to set as the value of "_id" fieldthis
for chainingByteBuffer getIdBinary()
TypeException
- if the _id of this Document is not of the BINARY typeboolean isReadOnly()
true
if this Document does not support any write
operations like set/delete etc.isReadOnly
in interface Container
int size()
<T> T toJavaBean(@API.NonNullable Class<T> beanClass) throws DecodingException
beanClass
- the class of instanceDecodingException
Document empty()
Document set(@API.NonNullable String fieldPath, @API.NonNullable String value)
fieldPath
- the FieldPath to setvalue
- the String valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable String value)
fieldPath
- the FieldPath to setvalue
- the String valuethis
for chainingDocument set(@API.NonNullable String fieldPath, boolean value)
fieldPath
- the FieldPath to setvalue
- the boolean valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, boolean value)
fieldPath
- the FieldPath to setvalue
- the boolean valuethis
for chainingDocument set(@API.NonNullable String fieldPath, byte value)
fieldPath
- the FieldPath to setvalue
- the byte valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, byte value)
fieldPath
- the FieldPath to setvalue
- the byte valuethis
for chainingDocument set(@API.NonNullable String fieldPath, short value)
fieldPath
- the FieldPath to setvalue
- the short valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, short value)
fieldPath
- the FieldPath to setvalue
- the short valuethis
for chaining.Document set(@API.NonNullable String fieldPath, int value)
fieldPath
- the FieldPath to setvalue
- the int valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, int value)
fieldPath
- the FieldPath to setvalue
- the int valuethis
for chainingDocument set(@API.NonNullable String fieldPath, long value)
fieldPath
- the FieldPath to setvalue
- the long valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, long value)
fieldPath
- the FieldPath to setvalue
- the long valuethis
for chainingDocument set(@API.NonNullable String fieldPath, float value)
fieldPath
- the FieldPath to setvalue
- the float valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, float value)
fieldPath
- the FieldPath to setvalue
- the float valuethis
for chainingDocument set(@API.NonNullable String fieldPath, double value)
fieldPath
- the FieldPath to setvalue
- the double valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, double value)
fieldPath
- the FieldPath to setvalue
- the double valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable BigDecimal value)
fieldPath
- the FieldPath to setvalue
- the BigDecimal valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable BigDecimal value)
fieldPath
- the FieldPath to setvalue
- the BigDecimal valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable OTime value)
fieldPath
- the FieldPath to setvalue
- the Time valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable OTime value)
fieldPath
- the FieldPath to setvalue
- the Time valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable ODate value)
fieldPath
- the FieldPath to setvalue
- the Date valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable ODate value)
fieldPath
- the FieldPath to setvalue
- the Date valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable OTimestamp value)
fieldPath
- the FieldPath to setvalue
- the Timestamp valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable OTimestamp value)
fieldPath
- the FieldPath to setvalue
- the Timestamp valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable OInterval value)
fieldPath
- the FieldPath to setvalue
- the Interval valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable OInterval value)
fieldPath
- the FieldPath to setvalue
- the Interval valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable byte[] value)
fieldPath
- the FieldPath to setvalue
- the byte array containing the binary valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable byte[] value)
fieldPath
- the FieldPath to setvalue
- the byte array containing the binary valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable byte[] value, int off, int len)
fieldPath
- the FieldPath to setvalue
- the byte array containing the binary valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable byte[] value, int off, int len)
fieldPath
- the FieldPath to setvalue
- the byte array containing the binary valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable ByteBuffer value)
fieldPath
- the FieldPath to setvalue
- the ByteBufferthis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable ByteBuffer value)
fieldPath
- the FieldPath to setvalue
- the ByteBufferthis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable Map<String,? extends Object> value)
fieldPath
- the FieldPath to setvalue
- the Map valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable Map<String,? extends Object> value)
fieldPath
- the FieldPath to setvalue
- the Map valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable Document value)
fieldPath
- the FieldPath to setvalue
- the Documentthis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable Document value)
fieldPath
- the FieldPath to setvalue
- the Documentthis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable Value value)
fieldPath
- the FieldPath to setvalue
- the Valuethis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable Value value)
fieldPath
- the FieldPath to setvalue
- the Valuethis
for chainingDocument set(@API.NonNullable String fieldPath, @API.NonNullable List<? extends Object> value)
fieldPath
- the FieldPath to setvalue
- the Object Listthis
for chainingDocument set(@API.NonNullable FieldPath fieldPath, @API.NonNullable List<? extends Object> value)
fieldPath
- the FieldPath to setvalue
- the Object Listthis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable boolean[] values)
fieldPath
- the FieldPath to setvalues
- the boolean arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable boolean[] values)
fieldPath
- the FieldPath to setvalues
- the boolean arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable byte[] values)
fieldPath
- the FieldPath to setvalues
- the byte arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable byte[] values)
fieldPath
- the FieldPath to setvalues
- the byte arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable short[] values)
fieldPath
- the FieldPath to setvalues
- the short arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable short[] values)
fieldPath
- the FieldPath to setvalues
- the short arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable int[] values)
fieldPath
- the FieldPath to setvalues
- the int arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable int[] values)
fieldPath
- the FieldPath to setvalues
- the int arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable long[] values)
fieldPath
- the FieldPath to setvalues
- the long arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable long[] values)
fieldPath
- the FieldPath to setvalues
- the long arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable float[] values)
fieldPath
- the FieldPath to setvalues
- the float arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable float[] values)
fieldPath
- the FieldPath to setvalues
- the float arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable double[] values)
fieldPath
- the FieldPath to setvalues
- the double arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable double[] values)
fieldPath
- the FieldPath to setvalues
- the double arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable String[] values)
fieldPath
- the FieldPath to setvalues
- the String arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable String[] values)
fieldPath
- the FieldPath to setvalues
- the String arraythis
for chainingDocument setArray(@API.NonNullable String fieldPath, @API.NonNullable Object... values)
fieldPath
- the FieldPath to setvalues
- the Object arraythis
for chainingDocument setArray(@API.NonNullable FieldPath fieldPath, @API.NonNullable Object... values)
fieldPath
- the FieldPath to setvalues
- the Object arraythis
for chainingDocument setNull(@API.NonNullable String fieldPath)
Value.Type.NULL
.fieldPath
- the FieldPath to setthis
for chainingDocument setNull(@API.NonNullable FieldPath fieldPath)
Value.Type.NULL
.fieldPath
- the FieldPath to setthis
for chainingDocument delete(@API.NonNullable String fieldPath)
FieldPath
if it exists.fieldPath
- the fieldPath
to delete from the documentthis
for chainingDocument delete(@API.NonNullable FieldPath fieldPath)
FieldPath
if it exists.fieldPath
- the fieldPath
to delete from the documentthis
for chainingString getString(@API.NonNullable String fieldPath)
String
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not of
the STRING
typeString getString(@API.NonNullable FieldPath fieldPath)
String
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not of
the STRING
typeboolean getBoolean(@API.NonNullable String fieldPath)
boolean
.TypeException
- if the value at the fieldPath is not of
BOOLEAN
typeNoSuchElementException
- if the specified field does not
exist in the Document
boolean getBoolean(@API.NonNullable FieldPath fieldPath)
boolean
.TypeException
- if the value at the fieldPath is not of
BOOLEAN
typeNoSuchElementException
- if the specified field does not
exist in the Document
Boolean getBooleanObj(@API.NonNullable String fieldPath)
Boolean
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not of
the BOOLEAN
typeBoolean getBooleanObj(@API.NonNullable FieldPath fieldPath)
Boolean
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not of
the BOOLEAN
typebyte getByte(@API.NonNullable String fieldPath)
byte
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
byte getByte(@API.NonNullable FieldPath fieldPath)
byte
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Byte getByteObj(@API.NonNullable String fieldPath)
Byte
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesByte getByteObj(@API.NonNullable FieldPath fieldPath)
Byte
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesshort getShort(@API.NonNullable String fieldPath)
short
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
short getShort(@API.NonNullable FieldPath fieldPath)
short
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Short getShortObj(@API.NonNullable String fieldPath)
Short
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesShort getShortObj(@API.NonNullable FieldPath fieldPath)
Short
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesint getInt(@API.NonNullable String fieldPath)
int
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
int getInt(@API.NonNullable FieldPath fieldPath)
int
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Integer getIntObj(@API.NonNullable String fieldPath)
Integer
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesInteger getIntObj(@API.NonNullable FieldPath fieldPath)
Integer
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typeslong getLong(@API.NonNullable String fieldPath)
long
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
long getLong(@API.NonNullable FieldPath fieldPath)
long
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Long getLongObj(@API.NonNullable String fieldPath)
Long
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesLong getLongObj(@API.NonNullable FieldPath fieldPath)
Long
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesfloat getFloat(@API.NonNullable String fieldPath)
float
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
float getFloat(@API.NonNullable FieldPath fieldPath)
float
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Float getFloatObj(@API.NonNullable String fieldPath)
Float
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesFloat getFloatObj(@API.NonNullable FieldPath fieldPath)
Float
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesdouble getDouble(@API.NonNullable String fieldPath)
double
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
double getDouble(@API.NonNullable FieldPath fieldPath)
double
.TypeException
- if the value at the fieldPath is not one of
the numeric typesNoSuchElementException
- if the specified field does not
exist in the Document
Double getDoubleObj(@API.NonNullable String fieldPath)
Double
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesDouble getDoubleObj(@API.NonNullable FieldPath fieldPath)
Double
object or null
if the specified FieldPath
does
not exist in the document.TypeException
- if the value at the fieldPath is not one of
the numeric typesBigDecimal getDecimal(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not one of
the numeric typesBigDecimal getDecimal(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not one of
the numeric typesOTime getTime(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the TIME
typeOTime getTime(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the TIME
typeODate getDate(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the DATE
typeODate getDate(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the DATE
typeOTimestamp getTimestamp(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the TIMESTAMP
typeOTimestamp getTimestamp(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the TIMESTAMP
typeByteBuffer getBinary(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the BINARY
typeByteBuffer getBinary(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
BINARY
typeOInterval getInterval(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the INTERVAL
typeOInterval getInterval(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the INTERVAL
typeValue getValue(@API.NonNullable String fieldPath)
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.Value getValue(@API.NonNullable FieldPath fieldPath)
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.Map<String,Object> getMap(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the MAP
typeMap<String,Object> getMap(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the MAP
typeList<Object> getList(@API.NonNullable String fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the ARRAY
typeList<Object> getList(@API.NonNullable FieldPath fieldPath)
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.TypeException
- if the value at the fieldPath is not of
the ARRAY
typeString toString()
DocumentReader asReader()
DocumentReader
over the current document
DocumentReader asReader(@API.NonNullable String fieldPath)
DocumentReader
over the node specified by the
fieldPath or null
if the node does not existDocumentReader asReader(@API.NonNullable FieldPath fieldPath)
DocumentReader
over the node specified by the
fieldPath or null
if the node does not existCopyright © 2015–2018 MapR Technologies, Inc.. All rights reserved.