org.bson.codecs

类 BsonDocumentCodec

java.lang.Object

org.bson.codecs.BsonDocumentCodec

所有已实现的接口:

Codec<BsonDocument>, CollectibleCodec<BsonDocument>, Decoder<BsonDocument>, Encoder<BsonDocument>

public class BsonDocumentCodec
extends java.lang.Object
implements CollectibleCodec<BsonDocument>

A codec for BsonDocument instances.

从以下版本开始:

3.0

构造器概要

构造器

构造器和说明
BsonDocumentCodec() Creates a new instance with a default codec registry that uses the BsonValueCodecProvider.
BsonDocumentCodec(CodecRegistry codecRegistry) Creates a new instance initialised with the given codec registry.

方法概要

限定符和类型	方法和说明
BsonDocument	decode(BsonReader reader, DecoderContext decoderContext) Decodes a BSON value from the given reader into an instance of the type parameter T.
boolean	documentHasId(BsonDocument document) Returns true if the given document has an _id.
void	encode(BsonWriter writer, BsonDocument value, EncoderContext encoderContext) Encode an instance of the type parameter T into a BSON value.
BsonDocument	generateIdIfAbsentFromDocument(BsonDocument document) Generates a value for the _id field on the given document, if the document does not have one.
CodecRegistry	getCodecRegistry() Gets the CodecRegistry for this Codec.
BsonValue	getDocumentId(BsonDocument document) Gets the _id of the given document if it contains one, otherwise throws IllegalArgumentException.
java.lang.Class<BsonDocument>	getEncoderClass() Returns the Class instance that this encodes.
protected BsonValue	readValue(BsonReader reader, DecoderContext decoderContext) This method may be overridden to change the behavior of reading the current value from the given BsonReader.

从类继承的方法 java.lang.Object

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

构造器详细资料

BsonDocumentCodec

public BsonDocumentCodec()

Creates a new instance with a default codec registry that uses the BsonValueCodecProvider.

BsonDocumentCodec

public BsonDocumentCodec(CodecRegistry codecRegistry)

Creates a new instance initialised with the given codec registry.

参数:

codecRegistry - the CodecRegistry to use to look up the codecs for encoding and decoding to/from BSON

方法详细资料

getCodecRegistry

public CodecRegistry getCodecRegistry()

Gets the CodecRegistry for this Codec.

返回:

the registry

decode

public BsonDocument decode(BsonReader reader,
                           DecoderContext decoderContext)

从接口复制的说明: Decoder

Decodes a BSON value from the given reader into an instance of the type parameter T.

指定者:

decode 在接口中 Decoder<BsonDocument>

参数:

reader - the BSON reader

decoderContext - the decoder context

返回:

an instance of the type parameter T.

readValue

protected BsonValue readValue(BsonReader reader,
                              DecoderContext decoderContext)

This method may be overridden to change the behavior of reading the current value from the given BsonReader. It is required that the value be fully consumed before returning.

参数:

reader - the read to read the value from

decoderContext - the context

返回:

the non-null value read from the reader

encode

public void encode(BsonWriter writer,
                   BsonDocument value,
                   EncoderContext encoderContext)

从接口复制的说明: Encoder

Encode an instance of the type parameter T into a BSON value.

指定者:

encode 在接口中 Encoder<BsonDocument>

参数:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

getEncoderClass

public java.lang.Class<BsonDocument> getEncoderClass()

从接口复制的说明: Encoder

Returns the Class instance that this encodes. This is necessary because Java does not reify generic types.

指定者:

getEncoderClass 在接口中 Encoder<BsonDocument>

返回:

the Class instance that this encodes.

generateIdIfAbsentFromDocument

public BsonDocument generateIdIfAbsentFromDocument(BsonDocument document)

从接口复制的说明: CollectibleCodec

Generates a value for the _id field on the given document, if the document does not have one.

指定者:

generateIdIfAbsentFromDocument 在接口中 CollectibleCodec<BsonDocument>

参数:

document - the document for which to generate a value for the _id.

返回:

the document with the _id

documentHasId

public boolean documentHasId(BsonDocument document)

从接口复制的说明: CollectibleCodec

Returns true if the given document has an _id.

指定者:

documentHasId 在接口中 CollectibleCodec<BsonDocument>

参数:

document - the document in which to look for an _id

返回:

true if the document has an _id

getDocumentId

public BsonValue getDocumentId(BsonDocument document)

从接口复制的说明: CollectibleCodec

Gets the _id of the given document if it contains one, otherwise throws IllegalArgumentException. To avoid the latter case, call documentHasId first to check.

指定者:

getDocumentId 在接口中 CollectibleCodec<BsonDocument>

参数:

document - the document from which to get the _id

返回:

the _id of the document