Top Description Fields Constructors Methods
com.mysql.cj.xdevapi

public Class DbDocImpl

extends TreeMap<String, JsonValue>
implements DbDoc
Class Inheritance
All Implemented Interfaces
com.mysql.cj.xdevapi.DbDoc, java.util.Map, com.mysql.cj.xdevapi.JsonValue
Imports
java.util.TreeMap

Represents a JSON object:
  {}
  or
  {key : value}
  or
  {key : value, key : value, ...}
key is a JSON string. value is any of JSON object, array, number, string, true, false, null. Example of valid JSON object:
{
"field1" : "value 1",
"field2" : 1.234544E+26,
"field3" : true,
"field4" : false,
"field5" : null,
"field6" : {
           "inner field 1" : "inner value 1",
           "inner field 2" : 2,
           "inner field 3" : true,
           "inner field 4" : false,
           "inner field 5" : null,
           "inner field 6" : [],
           "inner field 7" : {}
           },
"field7" : ["arr1", 3, true, false, null, [], {}]
}
To create DbDoc from existing string representation you need to use JsonParser#parseDoc(java.io.StringReader) method:

DbDoc doc = JsonParser.parseDoc(new StringReader("{\"key1\" : \"value1\"}"));
You can construct JSON document by DbDoc, JsonString, JsonNumber, JsonArray and JsonLiteral methods and get JSON string representation by using toString() method. For example, to get the document shown above:
DbDoc doc = new DbDoc().add("field1", new JsonString().setValue("value 1")).add("field2", new JsonNumber().setValue("12345.44E22"))
        .add("field3", JsonLiteral.TRUE).add("field4", JsonLiteral.FALSE).add("field5", JsonLiteral.NULL)
        .add("field6",
                new DbDoc().add("inner field 1", new JsonString().setValue("inner value 1")).add("inner field 2", new JsonNumber().setValue("2"))
                        .add("inner field 3", JsonLiteral.TRUE).add("inner field 4", JsonLiteral.FALSE).add("inner field 5", JsonLiteral.NULL)
                        .add("inner field 6", new JsonArray()).add("inner field 7", new DbDoc()))
        .add("field7", new JsonArray().addValue(new JsonString().setValue("arr1")).addValue(new JsonNumber().setValue("3")).addValue(JsonLiteral.TRUE)
                .addValue(JsonLiteral.FALSE).addValue(JsonLiteral.NULL).addValue(new JsonArray()).addValue(new DbDoc()));

doc.toString();

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public DbDoc
add(String
field key
key
,
JsonValue
field value
val
)

Implements com.mysql.cj.xdevapi.DbDoc.add.

Add JsonValue to the top-level document hierarchy.

public String
toFormattedString()

Overrides default com.mysql.cj.xdevapi.JsonValue.toFormattedString.

Get a human readable "pretty" JSON string.

public String
toString()

Overrides java.util.AbstractMap.toString.

Returns a string representation of this map.

Inherited from java.util.TreeMap:
ceilingEntryceilingKeyclearclonecomparatorcomputecomputeIfAbsentcomputeIfPresentcontainsKeycontainsValuedescendingKeySetdescendingMapentrySetfirstEntryfirstKeyfloorEntryfloorKeyforEachgetheadMapheadMaphigherEntryhigherKeykeySetlastEntrylastKeylowerEntrylowerKeymergenavigableKeySetpollFirstEntrypollLastEntryputputAllputFirstputIfAbsentputLastremovereplacereplacereplaceAllsizesubMapsubMaptailMaptailMapvalues

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.util.TreeMap.serialVersionUID.

Constructor Detail

DbDocImplback to summary
public DbDocImpl()

Method Detail

addback to summary
public DbDoc add(String key, JsonValue val)

Implements com.mysql.cj.xdevapi.DbDoc.add.

Doc from com.mysql.cj.xdevapi.DbDoc.add.

Add JsonValue to the top-level document hierarchy.

Parameters
key:String

field key

val:JsonValue

field value

Returns:DbDoc

DbDoc

Annotations
@Override
toFormattedStringback to summary
public String toFormattedString()

Overrides default com.mysql.cj.xdevapi.JsonValue.toFormattedString.

Doc from com.mysql.cj.xdevapi.JsonValue.toFormattedString.

Get a human readable "pretty" JSON string.

Returns:String

human readable "pretty" JSON string

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.util.AbstractMap.toString.

Doc from java.util.AbstractMap.toString.

Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's entrySet view's iterator, enclosed in braces ("{}"). Adjacent mappings are separated by the characters ", " (comma and space). Each key-value mapping is rendered as the key followed by an equals sign ("=") followed by the associated value. Keys and values are converted to strings as by String#valueOf(Object).

Returns:String

a string representation of this map

Annotations
@Override