Class ParameterBindingDocumentCodec

java.lang.Object

org.springframework.data.mongodb.util.json.ParameterBindingDocumentCodec

All Implemented Interfaces:

Codec<Document>, CollectibleCodec<Document>, Decoder<Document>, Encoder<Document>

@NullUnmarked
public class ParameterBindingDocumentCodec
extends Object
implements CollectibleCodec<Document>

A Codec implementation that allows binding parameters to placeholders or SpEL expressions when decoding a JSON String.
Modified version of MongoDB Inc. DocumentCodec licensed under the Apache License, Version 2.0.

Since:

2.2

Author:

Jeff Yemin, Ross Lawley, Ralph Schaer, Christoph Strobl, Rocco Lagrotteria

Constructor Summary

Constructors

Constructor	Description
ParameterBindingDocumentCodec()	Construct a new instance with a default CodecRegistry.
ParameterBindingDocumentCodec(CodecRegistry registry)	Construct a new instance with the given registry.
ParameterBindingDocumentCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap)	Construct a new instance with the given registry and BSON type class map.
ParameterBindingDocumentCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap, Transformer valueTransformer)	Construct a new instance with the given registry and BSON type class map.

Method Summary

Modifier and Type	Method	Description
ExpressionDependencies	captureExpressionDependencies(@Nullable String json, ValueProvider valueProvider, ValueExpressionParser expressionParser)	Determine ExpressionDependencies from Expressions that are nested in the json content.
Document	decode(@Nullable String json, Object... values)
Document	decode(@Nullable String json, ParameterBindingContext bindingContext)
Document	decode(BsonReader reader, DecoderContext decoderContext)
boolean	documentHasId(Document document)
void	encode(BsonWriter writer, Document document, EncoderContext encoderContext)
Document	generateIdIfAbsentFromDocument(Document document)
BsonValue	getDocumentId(Document document)
Class<Document>	getEncoderClass()

Methods inherited from class Object

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

Constructor Details

ParameterBindingDocumentCodec

public ParameterBindingDocumentCodec()

Construct a new instance with a default CodecRegistry.

ParameterBindingDocumentCodec

public ParameterBindingDocumentCodec(CodecRegistry registry)

Construct a new instance with the given registry.

Parameters:

registry - the registry

ParameterBindingDocumentCodec

public ParameterBindingDocumentCodec(CodecRegistry registry,
 BsonTypeClassMap bsonTypeClassMap)

Construct a new instance with the given registry and BSON type class map.

Parameters:

registry - the registry

bsonTypeClassMap - the BSON type class map

ParameterBindingDocumentCodec

public ParameterBindingDocumentCodec(CodecRegistry registry,
 BsonTypeClassMap bsonTypeClassMap,
 Transformer valueTransformer)

Construct a new instance with the given registry and BSON type class map. The transformer is applied as a last step when decoding values, which allows users of this codec to control the decoding process. For example, a user of this class could substitute a value decoded as a Document with an instance of a special purpose class (e.g., one representing a DBRef in MongoDB).

Parameters:

registry - the registry

bsonTypeClassMap - the BSON type class map

valueTransformer - the value transformer to use as a final step when decoding the value of any field in the document

Method Details

documentHasId

public boolean documentHasId(Document document)

Specified by:

documentHasId in interface CollectibleCodec<Document>

getDocumentId

public BsonValue getDocumentId(Document document)

Specified by:

getDocumentId in interface CollectibleCodec<Document>

generateIdIfAbsentFromDocument

public Document generateIdIfAbsentFromDocument(Document document)

Specified by:

generateIdIfAbsentFromDocument in interface CollectibleCodec<Document>

encode

public void encode(BsonWriter writer,
 Document document,
 EncoderContext encoderContext)

Specified by:

encode in interface Encoder<Document>

decode

public Document decode(@Nullable String json,
 Object... values)

decode

public Document decode(@Nullable String json,
 ParameterBindingContext bindingContext)

captureExpressionDependencies

public ExpressionDependencies captureExpressionDependencies(@Nullable String json,
 ValueProvider valueProvider,
 ValueExpressionParser expressionParser)

Determine ExpressionDependencies from Expressions that are nested in the json content. Returns Optional.empty() if json is empty or of it does not contain any SpEL expressions.

Parameters:

json -

expressionParser -

Returns:

merged ExpressionDependencies object if expressions were found, otherwise ExpressionDependencies.none().

Since:

3.1

decode

public Document decode(BsonReader reader,
 DecoderContext decoderContext)

Specified by:

decode in interface Decoder<Document>

getEncoderClass

public Class<Document> getEncoderClass()

Specified by:

getEncoderClass in interface Encoder<Document>