Package org.springframework.data.mongodb

Class BindableMongoExpression

java.lang.Object

org.springframework.data.mongodb.BindableMongoExpression

All Implemented Interfaces:

MongoExpression

public class BindableMongoExpression
extends Object
implements MongoExpression

A MongoExpression using the ParameterBindingDocumentCodec for parsing a raw (json) expression. The expression will be wrapped within { ... } if necessary. The actual parsing and parameter binding of placeholders like ?0 is delayed upon first call on the target Document via toDocument().

 $toUpper : $name                -> { '$toUpper' : '$name' }

 { '$toUpper' : '$name' }        -> { '$toUpper' : '$name' }

 { '$toUpper' : '?0' }, "$name"  -> { '$toUpper' : '$name' }
 

Some types might require a special Codec. If so, make sure to provide a CodecRegistry containing the required codec via withCodecRegistry(CodecRegistry).

Since:

3.2

Author:

Christoph Strobl, Giacomo Baso

Constructor Summary

Constructors

Constructor	Description
BindableMongoExpression(String expression, @Nullable CodecRegistryProvider codecRegistryProvider, Object @Nullable [] args)	Create a new instance of BindableMongoExpression.
BindableMongoExpression(String expression, Object @Nullable [] args)	Create a new instance of BindableMongoExpression.

Method Summary

Modifier and Type	Method	Description
BindableMongoExpression	bind(Object... args)	Provide the arguments to bind to the placeholders via their index.
org.bson.Document	toDocument()	Obtain the native Document representation.
String	toString()
BindableMongoExpression	withCodecRegistry(org.bson.codecs.configuration.CodecRegistry codecRegistry)	Provide the CodecRegistry used to convert expressions.

Methods inherited from class java.lang.Object

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

Constructor Details

BindableMongoExpression

public BindableMongoExpression(String expression,
 Object @Nullable [] args)

Create a new instance of BindableMongoExpression.

Parameters:

expression - must not be null.

args - must not be null but may contain null elements.

BindableMongoExpression

public BindableMongoExpression(String expression,
 @Nullable CodecRegistryProvider codecRegistryProvider,
 Object @Nullable [] args)

Create a new instance of BindableMongoExpression.

Parameters:

expression - must not be null.

codecRegistryProvider - can be null.

args - must not be null but may contain null elements.

Method Details

withCodecRegistry

@Contract("_ -> new")
public BindableMongoExpression withCodecRegistry(org.bson.codecs.configuration.CodecRegistry codecRegistry)

Provide the CodecRegistry used to convert expressions.

Parameters:

codecRegistry - must not be null.

Returns:

new instance of BindableMongoExpression.

bind

@Contract("_ -> new")
public BindableMongoExpression bind(Object... args)

Provide the arguments to bind to the placeholders via their index.

Parameters:

args - must not be null.

Returns:

new instance of BindableMongoExpression.

toDocument

public org.bson.Document toDocument()

Description copied from interface: MongoExpression

Obtain the native Document representation.

Specified by:

toDocument in interface MongoExpression

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object