Package com.mongodb

Class DBRefCodec

  • All Implemented Interfaces:
    Codec<DBRef>, Decoder<DBRef>, Encoder<DBRef>

    @Deprecated(since="2021-05-27")
    public class DBRefCodec
    extends java.lang.Object
    implements Codec<DBRef>
    Deprecated.
    Usage of this API is not supported in AEM as a Cloud Service.
    A Codec for DBRef instances.
    Since:
    3.0
    • Constructor Summary

      Constructors 
      Constructor Description
      DBRefCodec​(CodecRegistry registry)
      Deprecated.
      Construct an instance with the given registry, which is used to encode the id of the referenced document.
    • Constructor Detail

      • DBRefCodec

        public DBRefCodec​(CodecRegistry registry)
        Deprecated.
        Construct an instance with the given registry, which is used to encode the id of the referenced document.
        Parameters:
        registry - the non-null codec registry
    • Method Detail

      • encode

        public void encode​(BsonWriter writer,
                           DBRef value,
                           EncoderContext encoderContext)
        Deprecated.
        Description copied from interface: Encoder
        Encode an instance of the type parameter T into a BSON value.
        Specified by:
        encode in interface Encoder<DBRef>
        Parameters:
        writer - the BSON writer to encode into
        value - the value to encode
        encoderContext - the encoder context
      • getEncoderClass

        public java.lang.Class<DBRef> getEncoderClass()
        Deprecated.
        Description copied from interface: Encoder
        Returns the Class instance that this encodes. This is necessary because Java does not reify generic types.
        Specified by:
        getEncoderClass in interface Encoder<DBRef>
        Returns:
        the Class instance that this encodes.
      • decode

        public DBRef decode​(BsonReader reader,
                            DecoderContext decoderContext)
        Deprecated.
        Description copied from interface: Decoder
        Decodes a BSON value from the given reader into an instance of the type parameter T.
        Specified by:
        decode in interface Decoder<DBRef>
        Parameters:
        reader - the BSON reader
        decoderContext - the decoder context
        Returns:
        an instance of the type parameter T.