org.springframework.data.mongodb.core.aggregation

Class StringOperators.ReplaceOne

java.lang.Object

org.springframework.data.mongodb.core.aggregation.StringOperators.ReplaceOne

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

StringOperators

public static class StringOperators.ReplaceOne
extends Object

AggregationExpression for $replaceOne which replaces the first instance of a search string in an input string with a replacement string.
NOTE: Requires MongoDB 4.4 or later.

Since:

3.4

Author:

Divya Srivastava, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAggregationExpression.Expand Expand a nested list of values to single entries or keep the list.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReplaceOne(Object value)

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value) Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	argumentMap() Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key) Check if the given key is available.
StringOperators.ReplaceOne	find(String value) The string to search for within the given input field.
StringOperators.ReplaceOne	findValueOf(AggregationExpression expression) Specify the AggregationExpression evaluating to the the string to search for within the given input field.
StringOperators.ReplaceOne	findValueOf(String fieldReference) Specify the reference to the field holding the string to search for within the given input field.
protected <T> T	get(int index) Get the value at a given index.
protected <T> T	get(Object key) Get the value for a given key.
protected String	getMongoMethod()
protected Map<String,Object>	remove(String key)
StringOperators.ReplaceOne	replacement(String replacement) The string to use to replace the first matched instance of find in input.
StringOperators.ReplaceOne	replacementOf(AggregationExpression expression) Specifies the AggregationExpression evaluating to the string to use to replace the first matched instance of find in input.
StringOperators.ReplaceOne	replacementOf(String fieldReference) Specifies the reference to the field holding the string to use to replace the first matched instance of find in input.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
static StringOperators.ReplaceOne	value(String value) Creates new StringOperators.ReplaceOne using the given as input.
static StringOperators.ReplaceOne	valueOf(AggregationExpression expression) Creates new StringOperators.ReplaceOne using the result of the provided AggregationExpression as input value.
static StringOperators.ReplaceOne	valueOf(String fieldReference) Creates new StringOperators.ReplaceOne using the value of the provided fieldReference as input value.
protected List<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationExpression

from, toDocument

Methods inherited from interface org.springframework.data.mongodb.MongoExpression

create, create

Constructor Detail

ReplaceOne

protected ReplaceOne(Object value)

Method Detail

value

public static StringOperators.ReplaceOne value(String value)

Creates new StringOperators.ReplaceOne using the given as input.

Parameters:

value - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

valueOf

public static StringOperators.ReplaceOne valueOf(String fieldReference)

Creates new StringOperators.ReplaceOne using the value of the provided fieldReference as input value.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

valueOf

public static StringOperators.ReplaceOne valueOf(AggregationExpression expression)

Creates new StringOperators.ReplaceOne using the result of the provided AggregationExpression as input value.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

replacement

public StringOperators.ReplaceOne replacement(String replacement)

The string to use to replace the first matched instance of find in input.

Parameters:

replacement - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

replacementOf

public StringOperators.ReplaceOne replacementOf(String fieldReference)

Specifies the reference to the field holding the string to use to replace the first matched instance of find in input.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

replacementOf

public StringOperators.ReplaceOne replacementOf(AggregationExpression expression)

Specifies the AggregationExpression evaluating to the string to use to replace the first matched instance of find in input.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

find

public StringOperators.ReplaceOne find(String value)

The string to search for within the given input field.

Parameters:

value - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

findValueOf

public StringOperators.ReplaceOne findValueOf(String fieldReference)

Specify the reference to the field holding the string to search for within the given input field.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

findValueOf

public StringOperators.ReplaceOne findValueOf(AggregationExpression expression)

Specify the AggregationExpression evaluating to the the string to search for within the given input field.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.ReplaceOne.

getMongoMethod

protected String getMongoMethod()

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

toDocument

public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
                              AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
                                    Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
                                      String key,
                                      Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

values

protected List<Object> values()

get

protected <T> T get(int index)

Get the value at a given index.

Type Parameters:

T -

Parameters:

index -

Returns:

Since:

2.1

get

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1