Class LocalDateCodec

java.lang.Object
org.bson.codecs.jsr310.LocalDateCodec
All Implemented Interfaces:
Codec<LocalDate>, Decoder<LocalDate>, Encoder<LocalDate>

public class LocalDateCodec extends Object
LocalDate Codec.

Encodes and decodes LocalDate objects to and from DateTime.

Converts the LocalDate values to and from ZoneOffset.UTC.

Since:
3.7
MongoDB documentation
reference/bson-types
  • Constructor Details

    • LocalDateCodec

      public LocalDateCodec()
  • Method Details

    • decode

      public LocalDate 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.
      Parameters:
      reader - the BSON reader
      decoderContext - the decoder context
      Returns:
      an instance of the type parameter T.
    • encode

      public void encode(BsonWriter writer, LocalDate value, EncoderContext encoderContext)
      Encode an instance of the type parameter T into a BSON value.

      Converts the LocalDate to ZoneOffset.UTC via LocalDate.atStartOfDay(ZoneId).

      Parameters:
      writer - the BSON writer to encode into
      value - the value to encode
      encoderContext - the encoder context
      Throws:
      CodecConfigurationException - if the LocalDate cannot be converted to a valid Bson DateTime.
    • getEncoderClass

      public Class<LocalDate> getEncoderClass()
      Description copied from interface: Encoder
      Returns the Class instance that this encodes. This is necessary because Java does not reify generic types.
      Returns:
      the Class instance that this encodes.