org.bson.codecs

类 DocumentCodec

java.lang.Object

org.bson.codecs.DocumentCodec

所有已实现的接口:

Codec<Document>, CollectibleCodec<Document>, Decoder<Document>, Encoder<Document>

public class DocumentCodec
extends java.lang.Object
implements CollectibleCodec<Document>

A Codec for Document instances.

从以下版本开始:

3.0

另请参阅:

Document

构造器概要

构造器

构造器和说明
DocumentCodec() Construct a new instance with a default CodecRegistry and
DocumentCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap) Construct a new instance with the given registry and BSON type class map.
DocumentCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap, Transformer valueTransformer) Construct a new instance with the given registry and BSON type class map.

方法概要

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

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

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

构造器详细资料

DocumentCodec

public DocumentCodec()

Construct a new instance with a default CodecRegistry and

DocumentCodec

public DocumentCodec(CodecRegistry registry,
                     BsonTypeClassMap bsonTypeClassMap)

Construct a new instance with the given registry and BSON type class map.

参数:

registry - the registry

bsonTypeClassMap - the BSON type class map

DocumentCodec

public DocumentCodec(CodecRegistry registry,
                     BsonTypeClassMap bsonTypeClassMap,
                     Transformer valueTransformer)

Construct a new instance with the given registry and BSON type class map. The transformer is applied as a last step when decoding values, which allows users of this codec to control the decoding process. For example, a user of this class could substitute a value decoded as a Document with an instance of a special purpose class (e.g., one representing a DBRef in MongoDB).

参数:

registry - the registry

bsonTypeClassMap - the BSON type class map

valueTransformer - the value transformer to use as a final step when decoding the value of any field in the document

方法详细资料

documentHasId

public boolean documentHasId(Document document)

从接口复制的说明: CollectibleCodec

Returns true if the given document has an _id.

指定者:

documentHasId 在接口中 CollectibleCodec<Document>

参数:

document - the document in which to look for an _id

返回:

true if the document has an _id

getDocumentId

public BsonValue getDocumentId(Document 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<Document>

参数:

document - the document from which to get the _id

返回:

the _id of the document

generateIdIfAbsentFromDocument

public Document generateIdIfAbsentFromDocument(Document document)

从接口复制的说明: CollectibleCodec

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

指定者:

generateIdIfAbsentFromDocument 在接口中 CollectibleCodec<Document>

参数:

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

返回:

the document with the _id

encode

public void encode(BsonWriter writer,
                   Document document,
                   EncoderContext encoderContext)

从接口复制的说明: Encoder

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

指定者:

encode 在接口中 Encoder<Document>

参数:

writer - the BSON writer to encode into

document - the value to encode

encoderContext - the encoder context

decode

public Document decode(BsonReader reader,
                       DecoderContext decoderContext)

从接口复制的说明: Decoder

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

指定者:

decode 在接口中 Decoder<Document>

参数:

reader - the BSON reader

decoderContext - the decoder context

返回:

an instance of the type parameter T.

getEncoderClass

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

从接口复制的说明: Encoder

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

指定者:

getEncoderClass 在接口中 Encoder<Document>

返回:

the Class instance that this encodes.