com.allanbank.mongodb.bson.json

Class Json

java.lang.Object

com.allanbank.mongodb.bson.json.Json

public class Json
extends Object

Json provides a simplified interface for parsing JSON documents into BSON Documents and also serializing BSON Documents into JSON text.

In addition to the basic JSON types the parser also supports the following standard MongoDB/BSON extensions:

BinData

Creates a BinaryElement. The first field is the sub-type, normally zero. The second field is the base64 encoded binary value:
{ a : BinData(0, "VVU=") } or { a : { $binary:"VVU=", $type:0 } }

HexData

Creates a BinaryElement. The first field is the sub-type, normally zero. The second field is the hex encoded binary value:
{ a : HexData(0, "cafe") }

ISODate

Creates a TimestampElement:
{ a : ISODate("2012-07-14T01:00:00.000") } or { a : { $date : "2012-07-14T01:00:00.000" } } or { a : { $date : 1234567890 } }

MaxKey

Creates a MaxKeyElement:
{ a : MaxKey } or { a : MaxKey() }

MinKey

Creates a MinKeyElement:
{ a : MinKey } or { a : MinKey() }

NumberLong

Creates a LongElement:
{ a : NumberLong("123456789") }

ObjectId

Creates an ObjectIdElement. The string is the hex encoding of the 128 bit value:
{ a : ObjectId("4e9d87aa5825b60b637815a6") } or { a : { $oid : "4e9d87aa5825b60b637815a6" } }

$regex

Creates an RegularExpressionElement:
{ a : { $regex : 'cat' , $options : 'i' } }

Timestamp

Creates a MongoTimestampElement. The first value is the seconds since the UNIX epoch. The second value is an ordinal:
{ a : Timestamp(0,0) } or { a : { $timestamp : { t : 0, i : 0 } } }

The following non-standard extensions are also provided. These extensions may be deprecated in future releases if standard extensions are created:

DBPointer

Creates a DBPointerElement:
{ a : DBPointer("db", 'collection', ObjectId("4e9d87aa5825b60b637815a6") ) }
Note: DBPointers are deprecated in favor of the DBRef convention

Note: Currently serialization/parsing round trip is not supported for the following Element types:

• JavaScriptElement
• JavaScriptWithScopeElement

See Also:

MongoDB Extended JSON

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
static Document	parse(Reader input) Parses the document from the reader into a BSON Document.
static Document	parse(String input) Parses the document from the reader into a BSON Document.
static String	serialize(DocumentAssignable document) Serializes the Document to an equivalent JSON document.
static void	serialize(DocumentAssignable document, Writer sink) Serializes the Document to an equivalent JSON document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parse

public static Document parse(Reader input)
                      throws JsonParseException

Parses the document from the reader into a BSON Document.

See the class documentation for important limitations on round trip serialization and parsing.

Parameters:

input - The source of the document to read.

Returns:

The Document representation of the JSON document.

Throws:

JsonParseException - On a failure to parse the JSON document.

parse

public static Document parse(String input)
                      throws JsonParseException

Parses the document from the reader into a BSON Document.

This method is equivalent to:

 
 parse(new StringReader(input));
 
 

See the class documentation for important limitations on round trip serialization and parsing.

Parameters:

input - The source of the document to read.

Returns:

The Document representation of the JSON document.

Throws:

JsonParseException - On a failure to parse the JSON document.

serialize

public static String serialize(DocumentAssignable document)
                        throws JsonException

Serializes the Document to an equivalent JSON document.

See the class documentation for important limitations on round trip serialization and parsing.

Parameters:

document - The document to conver to a JSON document.

Returns:

The JSON document text.

Throws:

JsonException - On a failure to write the JSON document.

serialize

public static void serialize(DocumentAssignable document,
             Writer sink)
                      throws JsonException

Serializes the Document to an equivalent JSON document.

See the class documentation for important limitations on round trip serialization and parsing.

Parameters:

document - The document to conver to a JSON document.

sink - The sink for the JSON document text.

Throws:

JsonException - On a failure to write the JSON document.