InstantCodec (bson 4.1.0 API)

java.lang.Object
- org.bson.codecs.jsr310.InstantCodec

All Implemented Interfaces:

Codec<Instant>, Decoder<Instant>, Encoder<Instant>
```
public class InstantCodec
extends Object
```
Instant Codec.
Encodes and decodes Instant objects to and from DateTime. Data is stored to millisecond accuracy.

Since:

3.7

MongoDB documentation
reference/bson-types

Constructor Summary

Constructors
Constructor Description

InstantCodec()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Instant`	`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, Instant value, EncoderContext encoderContext)`	Encode an instance of the type parameter `T` into a BSON value.
`Class<Instant>`	`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
  - InstantCodec
```
public InstantCodec()
```
- Method Detail
  - decode
```
public Instant 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,
                   Instant value,
                   EncoderContext encoderContext)
```
    Encode an instance of the type parameter T into a BSON value.
    
    Parameters:
    
    writer - the BSON writer to encode into
    
    value - the value to encode
    
    encoderContext - the encoder context
    
    Throws:
    
    CodecConfigurationException - if the Instant cannot be converted to a valid Bson DateTime.
  - getEncoderClass
```
public Class<Instant> 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.