org.springframework.data.mongodb.core.aggregation

Class StringOperators.RTrim

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression

Enclosing class:

StringOperators

public static class StringOperators.RTrim
extends Object

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

Since:

2.1

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	argumentMap() Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
StringOperators.RTrim	chars(String chars) Optional specify the character(s) to trim from the end.
StringOperators.RTrim	charsOf(AggregationExpression expression) Optional specify the AggregationExpression evaluating to the character sequence to trim from the end.
StringOperators.RTrim	charsOf(String fieldReference) Optional specify the reference to the field holding the character values to trim from the end.
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()
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.RTrim	valueOf(AggregationExpression expression) Creates new StringOperators.RTrim using the result of the provided AggregationExpression as input value.
static StringOperators.RTrim	valueOf(String fieldReference) Creates new StringOperators.RTrim 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

Method Detail

valueOf

public static StringOperators.RTrim valueOf(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.RTrim.

valueOf

public static StringOperators.RTrim valueOf(AggregationExpression expression)

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

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RTrim.

chars

public StringOperators.RTrim chars(String chars)

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

Parameters:

chars - must not be null.

Returns:

new instance of StringOperators.RTrim.

charsOf

public StringOperators.RTrim charsOf(String fieldReference)

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

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.RTrim.

charsOf

public StringOperators.RTrim charsOf(AggregationExpression expression)

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

Parameters:

expression - must not be null.

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

Returns:

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)

append

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

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