com.mongodb

类 DBObjectCodec

java.lang.Object

com.mongodb.DBObjectCodec

所有已实现的接口:

Codec<DBObject>, CollectibleCodec<DBObject>, Decoder<DBObject>, Encoder<DBObject>

public class DBObjectCodec
extends java.lang.Object
implements CollectibleCodec<DBObject>

A collectible codec for a DBObject.

从以下版本开始:

3.0

构造器概要

构造器

构造器和说明
DBObjectCodec(CodecRegistry codecRegistry) Construct an instance with the given codec registry.
DBObjectCodec(CodecRegistry codecRegistry, BsonTypeClassMap bsonTypeClassMap) Construct an instance.
DBObjectCodec(CodecRegistry codecRegistry, BsonTypeClassMap bsonTypeClassMap, com.mongodb.DBObjectFactory objectFactory) Construct an instance.

方法概要

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

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

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

构造器详细资料

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry)

Construct an instance with the given codec registry.

参数:

codecRegistry - the non-null codec registry

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry,
                     BsonTypeClassMap bsonTypeClassMap)

Construct an instance.

参数:

codecRegistry - the codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry,
                     BsonTypeClassMap bsonTypeClassMap,
                     com.mongodb.DBObjectFactory objectFactory)

Construct an instance.

参数:

codecRegistry - the non-null codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

objectFactory - the non-null object factory used to create empty DBObject instances when decoding

方法详细资料

encode

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

从接口复制的说明: Encoder

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

指定者:

encode 在接口中 Encoder<DBObject>

参数:

writer - the BSON writer to encode into

document - the value to encode

encoderContext - the encoder context

decode

public DBObject decode(BsonReader reader,
                       DecoderContext decoderContext)

从接口复制的说明: Decoder

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

指定者:

decode 在接口中 Decoder<DBObject>

参数:

reader - the BSON reader

decoderContext - the decoder context

返回:

an instance of the type parameter T.

getEncoderClass

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

从接口复制的说明: Encoder

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

指定者:

getEncoderClass 在接口中 Encoder<DBObject>

返回:

the Class instance that this encodes.

documentHasId

public boolean documentHasId(DBObject document)

从接口复制的说明: CollectibleCodec

Returns true if the given document has an _id.

指定者:

documentHasId 在接口中 CollectibleCodec<DBObject>

参数:

document - the document in which to look for an _id

返回:

true if the document has an _id

getDocumentId

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

参数:

document - the document from which to get the _id

返回:

the _id of the document

generateIdIfAbsentFromDocument

public DBObject generateIdIfAbsentFromDocument(DBObject document)

从接口复制的说明: CollectibleCodec

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

指定者:

generateIdIfAbsentFromDocument 在接口中 CollectibleCodec<DBObject>

参数:

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

返回:

the document with the _id