Class StringOperators.RegexFindAll
java.lang.Object
org.springframework.data.mongodb.core.aggregation.StringOperators.RegexFindAll
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- StringOperators
AggregationExpression
for $regexFindAll
which applies a regular expression (regex) to a string and
returns information on all the matched substrings. NOTE: Requires MongoDB 4.0 or later.
- Since:
- 3.3
- Author:
- Divya Srivastava
-
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.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
Optional specify the options to use with the regular expression.Optional specify the reference to thefield
holding the options values to use with the regular expression.optionsOf
(AggregationExpression expression) Optional specify theAggregationExpression
evaluating to the options values to use with the regular expression.Specify the regular expression to apply.Specify the reference to thefield
holding the regular expression to apply.regexOf
(AggregationExpression expression) Specify theAggregationExpression
evaluating to the regular expression to apply.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) static StringOperators.RegexFindAll
Creates newStringOperators.RegexFindAll
using the value of the providedfieldReference
as input value.static StringOperators.RegexFindAll
valueOf
(AggregationExpression expression) Creates newStringOperators.RegexFindAll
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
-
RegexFindAll
-
-
Method Details
-
valueOf
Creates newStringOperators.RegexFindAll
using the value of the providedfieldReference
as input value.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
valueOf
Creates newStringOperators.RegexFindAll
using the result of the providedAggregationExpression
as input value.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
options
Optional specify the options to use with the regular expression.- Parameters:
options
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
optionsOf
Optional specify the reference to thefield
holding the options values to use with the regular expression.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
optionsOf
Optional specify theAggregationExpression
evaluating to the options values to use with the regular expression.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
pattern
- Parameters:
pattern
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
regex
Specify the regular expression to apply.- Parameters:
regex
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
regexOf
Specify the reference to thefield
holding the regular expression to apply.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
regexOf
Specify theAggregationExpression
evaluating to the regular expression to apply.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.RegexFindAll
.
-
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
-