Package org.bson.codecs

Class UuidCodec

  • All Implemented Interfaces:
    Codec<java.util.UUID>, Decoder<java.util.UUID>, Encoder<java.util.UUID>
    public class UuidCodec
extends java.lang.Object
implements Codec<java.util.UUID>
    Encodes and decodes UUID objects.
    Since:
    3.0

    • Constructor Summary

      Constructors 
      Constructor Description
      UuidCodec()
      The constructor for UUIDCodec, default is JAVA_LEGACY
      UuidCodec​(UuidRepresentation uuidRepresentation)
      The default UUIDRepresentation is JAVA_LEGACY to be compatible with existing documents

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.UUID decode​(BsonReader reader, DecoderContext decoderContext)
      Decodes a BSON value from the given reader into an instance of the type parameter T.
      void encode​(BsonWriter writer, java.util.UUID value, EncoderContext encoderContext)
      Encode an instance of the type parameter T into a BSON value.
      java.lang.Class<java.util.UUID> getEncoderClass()
      Returns the Class instance that this encodes.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UuidCodec

        public UuidCodec​(UuidRepresentation uuidRepresentation)
        The default UUIDRepresentation is JAVA_LEGACY to be compatible with existing documents
        Parameters:
        uuidRepresentation - the representation of UUID
        See Also:
        UuidRepresentation

      • UuidCodec

        public UuidCodec()
        The constructor for UUIDCodec, default is JAVA_LEGACY

    • Method Detail

      • encode

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

      • decode

        public java.util.UUID decode​(BsonReader reader,
                             DecoderContext decoderContext)
        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<java.util.UUID>
        Parameters:
        reader - the BSON reader
        decoderContext - the decoder context
        Returns:
        an instance of the type parameter T.

      • getEncoderClass

        public java.lang.Class<java.util.UUID> getEncoderClass()
        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<java.util.UUID>
        Returns:
        the Class instance that this encodes.