StringOperators.LTrim (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.aggregation.StringOperators.LTrim

All Implemented Interfaces:

AggregationExpression

Enclosing class:

StringOperators
```
public static class StringOperators.LTrim
extends Object
```
AggregationExpression for $ltrim which removes whitespace or the specified characters from the beginning of a string.
NOTE: Requires MongoDB 4.0 or later.

Since:

2.1

Author:

Christoph Strobl

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.LTrim`	`chars(String chars)` Optional specify the character(s) to trim from the beginning.
`StringOperators.LTrim`	`charsOf(AggregationExpression expression)` Optional specify the `AggregationExpression` evaluating to the character sequence to trim from the beginning.
`StringOperators.LTrim`	`charsOf(String fieldReference)` Optional specify the reference to the `field` holding the character values 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()`
`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.LTrim`	`valueOf(AggregationExpression expression)` Creates new `StringOperators.LTrim` using the result of the provided `AggregationExpression` as input value.
`static StringOperators.LTrim`	`valueOf(String fieldReference)` Creates new `StringOperators.LTrim` 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.LTrim valueOf(String fieldReference)
```
    Creates new StringOperators.LTrim 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.LTrim valueOf(AggregationExpression expression)
```
    Creates new StringOperators.LTrim using the result of the provided AggregationExpression as input value.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
    
    new instance of StringOperators.LTrim.
  - chars
```
public StringOperators.LTrim chars(String chars)
```
    Optional specify the character(s) to trim from the beginning.
    
    Parameters:
    
    chars - must not be null.
    
    Returns:
    
    new instance of StringOperators.LTrim.
  - charsOf
```
public StringOperators.LTrim 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.LTrim.
  - charsOf
```
public StringOperators.LTrim 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.LTrim.
  - 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

Class StringOperators.LTrim

Method Summary

Methods inherited from class java.lang.Object

Method Detail

valueOf

valueOf

chars

charsOf

charsOf

getMongoMethod

toDocument

toDocument

asFields

append

append

values

get

get

argumentMap

contains