Package org.bson.conversions

Interface Bson

All Known Implementing Classes:

BsonDocument, BsonDocumentWrapper, Document, JsonObject, RawBsonDocument

public interface Bson

An interface for types that are able to render themselves into a BsonDocument.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CodecRegistry	DEFAULT_CODEC_REGISTRY	This registry includes the following providers: ValueCodecProvider BsonValueCodecProvider DocumentCodecProvider CollectionCodecProvider IterableCodecProvider MapCodecProvider Jsr310CodecProvider JsonObjectCodecProvider BsonCodecProvider EnumCodecProvider

Method Summary

Modifier and Type	Method	Description
default BsonDocument	toBsonDocument()	Render into a BsonDocument using a document class and codec registry appropriate for the implementation.
<TDocument> BsonDocument	toBsonDocument(Class<TDocument> documentClass, CodecRegistry codecRegistry)	Render into a BsonDocument.

Field Details

DEFAULT_CODEC_REGISTRY

static final CodecRegistry DEFAULT_CODEC_REGISTRY

This registry includes the following providers:

• ValueCodecProvider
• BsonValueCodecProvider
• DocumentCodecProvider
• CollectionCodecProvider
• IterableCodecProvider
• MapCodecProvider
• Jsr310CodecProvider
• JsonObjectCodecProvider
• BsonCodecProvider
• EnumCodecProvider

Additional providers may be added in a future release.

Since:

4.2

Method Details

toBsonDocument

<TDocument> BsonDocument toBsonDocument(Class<TDocument> documentClass,
 CodecRegistry codecRegistry)

Render into a BsonDocument.

Type Parameters:

TDocument - the type of the document class

Parameters:

documentClass - the document class in scope for the collection. This parameter may be ignored, but it may be used to alter the structure of the returned BsonDocument based on some knowledge of the document class.

codecRegistry - the codec registry. This parameter may be ignored, but it may be used to look up Codec instances for the document class or any other related class.

Returns:

the BsonDocument

toBsonDocument

default BsonDocument toBsonDocument()

Render into a BsonDocument using a document class and codec registry appropriate for the implementation.

The default implementation of this method calls toBsonDocument(Class, CodecRegistry) with the BsonDocument class as the first argument and DEFAULT_CODEC_REGISTRY as the second argument.

Returns:

the BsonDocument

Since:

4.2