Package org.bson.codecs.jsr310

Class LocalTimeCodec

java.lang.Object

org.bson.codecs.jsr310.LocalTimeCodec

All Implemented Interfaces:

Codec<LocalTime>, Decoder<LocalTime>, Encoder<LocalTime>

public class LocalTimeCodec
extends Object

LocalTime Codec.

Encodes and decodes LocalTime objects to and from DateTime. Data is stored to millisecond accuracy.

Converts the LocalTime values to and from EpochDay at ZoneOffset.UTC.

Note: Requires Java 8 or greater.

Since:

3.7

MongoDB documentation

reference/bson-types

Constructor Summary

Constructors

Constructor	Description
LocalTimeCodec()

Method Summary

Modifier and Type	Method	Description
LocalTime	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, LocalTime value, EncoderContext encoderContext)	Encode an instance of the type parameter T into a BSON value.
Class<LocalTime>	getEncoderClass()	Returns the Class instance that this encodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalTimeCodec

public LocalTimeCodec()

Method Detail

decode

public LocalTime 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,
                   LocalTime value,
                   EncoderContext encoderContext)

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

Converts the LocalTime to ZoneOffset.UTC at EpochDay via LocalTime.atDate(LocalDate) and ChronoLocalDateTime.toInstant(ZoneOffset).

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

getEncoderClass

public Class<LocalTime> 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.