Class StringOperators.ReplaceOne
java.lang.Object
org.springframework.data.mongodb.core.aggregation.StringOperators.ReplaceOne
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- StringOperators
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionappend
(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList) Append the given key at the position in the underlyingLinkedHashMap
.Get the argument map.protected boolean
Check if the given key is available.The string to search for within the given input field.findValueOf
(String fieldReference) Specify the reference to thefield
holding the string to search for within the given input field.findValueOf
(AggregationExpression expression) Specify theAggregationExpression
evaluating to the 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 the value for a given key.protected String
protected boolean
replacement
(String replacement) The string to use to replace the first matched instance offind
in input.replacementOf
(String fieldReference) Specifies the reference to thefield
holding the string to use to replace the first matched instance offind
in input.replacementOf
(AggregationExpression expression) Specifies theAggregationExpression
evaluating to the string to use to replace the first matched instance offind
ininput
.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) static StringOperators.ReplaceOne
Creates newStringOperators.ReplaceOne
using the given as input.static StringOperators.ReplaceOne
Creates newStringOperators.ReplaceOne
using the value of the providedfieldReference
as input value.static StringOperators.ReplaceOne
valueOf
(AggregationExpression expression) Creates newStringOperators.ReplaceOne
using the result of the providedAggregationExpression
as input value.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
toDocument
-
Constructor Details
-
ReplaceOne
-
-
Method Details
-
value
Creates newStringOperators.ReplaceOne
using the given as input.- Parameters:
value
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
valueOf
Creates newStringOperators.ReplaceOne
using the value of the providedfieldReference
as input value.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
valueOf
Creates newStringOperators.ReplaceOne
using the result of the providedAggregationExpression
as input value.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
replacement
The string to use to replace the first matched instance offind
in input.- Parameters:
replacement
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
replacementOf
Specifies the reference to thefield
holding the string to use to replace the first matched instance offind
in input.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
replacementOf
Specifies theAggregationExpression
evaluating to the string to use to replace the first matched instance offind
ininput
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
find
The string to search for within the given input field.- Parameters:
value
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
findValueOf
Specify the reference to thefield
holding the string to search for within the given input field.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.ReplaceOne
.
-
findValueOf
Specify theAggregationExpression
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
-
toDocument
Description copied from interface:AggregationExpression
- Specified by:
toDocument
in interfaceAggregationExpression
- Parameters:
context
- must not be null.- Returns:
- the MongoDB native (
Document
) form of the expression.
-
toDocument
-
asFields
-
append
-
append
-
append
-
appendTo
-
remove
-
appendAt
Append the given key at the position in the underlyingLinkedHashMap
.- Parameters:
index
-key
-value
-- Returns:
- Since:
- 3.1
-
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
Get the value for a given key.- Type Parameters:
T
-- Parameters:
key
-- Returns:
- Since:
- 2.1
-
isArgumentMap
protected boolean isArgumentMap() -
argumentMap
Get the argument map.- Returns:
- Since:
- 2.1
-
contains
Check if the given key is available.- Parameters:
key
-- Returns:
- Since:
- 2.1
-