Package org.bson.codecs
Class UuidCodec
-
- org.bson.codecs.UuidCodec
-
- All Implemented Interfaces:
>
,>
,>
- Direct Known Subclasses:
OverridableUuidRepresentationUuidCodec
public class UuidCodec extends implements >
Encodes and decodesUUID
objects.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description UuidCodec()
The constructor for UUIDCodec, default is JAVA_LEGACYUuidCodec(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 decode(BsonReader reader, DecoderContext decoderContext)
Decodes a BSON value from the given reader into an instance of the type parameterT
.void
encode(BsonWriter writer, value, EncoderContext encoderContext)
Encode an instance of the type parameterT
into a BSON value.<>
getEncoderClass()
Returns the Class instance that this encodes.UuidRepresentation
getUuidRepresentation()
TheUuidRepresentation
with which this instance is configuredtoString()
-
-
-
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
-
getUuidRepresentation
public UuidRepresentation getUuidRepresentation()
TheUuidRepresentation
with which this instance is configured- Returns:
- the uuid representation
- Since:
- 3.12
-
encode
public void encode(BsonWriter writer, value, EncoderContext encoderContext)
Description copied from interface:Encoder
Encode an instance of the type parameterT
into a BSON value.- Specified by:
>
- Parameters:
writer
- the BSON writer to encode intovalue
- the value to encodeencoderContext
- the encoder context
-
decode
public decode(BsonReader reader, DecoderContext decoderContext)
Description copied from interface:Decoder
Decodes a BSON value from the given reader into an instance of the type parameterT
.- Specified by:
>
- Parameters:
reader
- the BSON readerdecoderContext
- the decoder context- Returns:
- an instance of the type parameter
T
.
-
getEncoderClass
public <> 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:
>
- Returns:
- the Class instance that this encodes.
-
toString
public toString()
- Overrides:
in class
-
-