Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class StringOperators.Trim

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

StringOperators

public static class StringOperators.Trim
extends Object

AggregationExpression for $trim which removes whitespace or the specified characters from the beginning and end of a string.
NOTE: Requires MongoDB 4.0 or later.

Since:

2.1

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.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>	appendTo(String key, Object value)
protected Map<String,Object>	argumentMap()	Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
StringOperators.Trim	chars(String chars)	Optional specify the character(s) to trim from the beginning.
StringOperators.Trim	charsOf(String fieldReference)	Optional specify the reference to the field holding the character values to trim from the beginning.
StringOperators.Trim	charsOf(AggregationExpression expression)	Optional specify the AggregationExpression evaluating to the character sequence to trim from the beginning.
protected boolean	contains(Object key)	Check if the given key is available.
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 boolean	isArgumentMap()
StringOperators.LTrim	left()	Remove whitespace or the specified characters from the beginning of a string.
protected Map<String,Object>	remove(String key)
StringOperators.RTrim	right()	Remove whitespace or the specified characters from the end of a string.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
static StringOperators.Trim	valueOf(String fieldReference)	Creates new StringOperators.Trim using the value of the provided fieldReference as input value.
static StringOperators.Trim	valueOf(AggregationExpression expression)	Creates new StringOperators.Trim using the result of the provided AggregationExpression 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

toDocument

Method Details

valueOf

public static StringOperators.Trim valueOf(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.LTrim.

valueOf

public static StringOperators.Trim valueOf(AggregationExpression expression)

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

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Trim.

chars

public StringOperators.Trim chars(String chars)

Optional specify the character(s) to trim from the beginning.

Parameters:

chars - must not be null.

Returns:

new instance of StringOperators.Trim.

charsOf

public StringOperators.Trim charsOf(String fieldReference)

Optional specify the reference to the field holding the character values to trim from the beginning.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.Trim.

charsOf

public StringOperators.Trim charsOf(AggregationExpression expression)

Optional specify the AggregationExpression evaluating to the character sequence to trim from the beginning.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Trim.

left

public StringOperators.LTrim left()

Remove whitespace or the specified characters from the beginning of a string.

Returns:

new instance of StringOperators.LTrim.

right

public StringOperators.RTrim right()

Remove whitespace or the specified characters from the end of a string.

Returns:

new instance of StringOperators.RTrim.

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,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

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

appendTo

protected Map<String,Object> appendTo(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

isArgumentMap

protected boolean isArgumentMap()

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