Expression (mongo-java-server-core 1.15.0 API)

java.lang.Object
- java.lang.Enum<Expression>
- - de.bwaldvogel.mongo.backend.aggregation.Expression

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Expression>
```
public enum Expression
extends java.lang.Enum<Expression>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`$abs`
`$add`
`$allElementsTrue`
`$and`
`$anyElementTrue`
`$arrayElemAt`
`$arrayToObject`
`$ceil`
`$cmp`
`$concat`
`$concatArrays`
`$cond`
`$dayOfMonth`
`$dayOfWeek`
`$dayOfYear`
`$divide`
`$eq`
`$exp`
`$filter`
`$floor`
`$gt`
`$gte`
`$hour`
`$ifNull`
`$in`
`$indexOfArray`
`$indexOfBytes`
`$indexOfCP`
`$isArray`
`$literal`
`$ln`
`$log`
`$log10`
`$lt`
`$lte`
`$map`
`$mergeObjects`
`$minute`
`$mod`
`$month`
`$multiply`
`$ne`
`$not`
`$objectToArray`
`$or`
`$pow`
`$range`
`$reverseArray`
`$second`
`$setDifference`
`$setEquals`
`$setIntersection`
`$setIsSubset`
`$setUnion`
`$size`
`$slice`
`$split`
`$sqrt`
`$subtract`
`$sum`
`$toLower`
`$toString`
`$toUpper`
`$trunc`
`$year`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`default int`	`evaluateComparison(java.util.List<?> expressionValue)`
`default boolean`	`evaluateComparison(java.util.List<?> expressionValue, java.util.function.IntPredicate comparison)`
`default <T> T`	`evaluateDate(java.util.List<?> expressionValue, java.util.function.Function<java.time.LocalDate,T> dateFunction, Document document)`
`default <T> T`	`evaluateDateTime(java.util.List<?> expressionValue, java.util.function.Function<java.time.ZonedDateTime,T> dateFunction, Document document)`
`static java.lang.Object`	`evaluateDocument(java.lang.Object documentWithExpression, Document document)`
`default <T> java.lang.Object`	`evaluateIndexOf(java.util.List<?> expressionValue, java.util.function.Function<java.lang.String,java.util.List<T>> toList, int errorCodeFirstParameterTypeMismatch, int errorCodeSecondParameterTypeMismatch)`
`default java.lang.Number`	`evaluateNumericValue(java.util.List<?> expressionValue, java.util.function.Function<java.lang.Double,? extends java.lang.Number> function)`
`default java.lang.String`	`evaluateString(java.util.List<?> expressionValue, java.util.function.Function<java.lang.String,java.lang.String> function)`
`default <T> T`	`evaluateTime(java.util.List<?> expressionValue, java.util.function.Function<java.time.LocalTime,T> timeFunction, Document document)`
`default java.time.ZonedDateTime`	`getZonedDateTime(java.lang.Object value, Document document)`
`java.lang.String`	`name()`
`default java.util.Collection<?>`	`requireArray(int errorCode, java.lang.Object value)`
`default java.util.List<?>`	`requireCollectionInSize(java.util.List<?> value, int expectedCollectionSize)`
`default Document`	`requireDocument(java.lang.Object expressionValue, int errorCode)`
`default int`	`requireIntegral(java.lang.Object value, java.lang.String name)`
`default java.lang.Object`	`requireSingleValue(java.util.List<?> list)`
`default de.bwaldvogel.mongo.backend.aggregation.TwoNumericParameters`	`requireTwoNumericParameters(java.util.List<?> value, int errorCode)`
`default de.bwaldvogel.mongo.backend.aggregation.TwoParameters`	`requireTwoParameters(java.util.List<?> value)`
`static Expression`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Expression[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

$abs
```
public static final Expression $abs
```

$add
```
public static final Expression $add
```

$and
```
public static final Expression $and
```

$anyElementTrue

public static final Expression $anyElementTrue

$allElementsTrue

public static final Expression $allElementsTrue

$arrayElemAt

public static final Expression $arrayElemAt

$arrayToObject

public static final Expression $arrayToObject

$ceil
```
public static final Expression $ceil
```

$cmp
```
public static final Expression $cmp
```

$concat
```
public static final Expression $concat
```

$concatArrays

public static final Expression $concatArrays

$cond
```
public static final Expression $cond
```

$dayOfMonth

public static final Expression $dayOfMonth

$dayOfWeek

public static final Expression $dayOfWeek

$dayOfYear

public static final Expression $dayOfYear

$divide
```
public static final Expression $divide
```

$eq
```
public static final Expression $eq
```

$exp
```
public static final Expression $exp
```

$filter
```
public static final Expression $filter
```

$floor
```
public static final Expression $floor
```

$gt
```
public static final Expression $gt
```

$gte
```
public static final Expression $gte
```

$hour
```
public static final Expression $hour
```

$ifNull
```
public static final Expression $ifNull
```

$in
```
public static final Expression $in
```

$indexOfArray

public static final Expression $indexOfArray

$indexOfBytes

public static final Expression $indexOfBytes

$indexOfCP

public static final Expression $indexOfCP

$isArray

public static final Expression $isArray

$literal

public static final Expression $literal

$ln
```
public static final Expression $ln
```

$log
```
public static final Expression $log
```

$log10
```
public static final Expression $log10
```

$lt
```
public static final Expression $lt
```

$lte
```
public static final Expression $lte
```

$map
```
public static final Expression $map
```

$mergeObjects

public static final Expression $mergeObjects

$minute
```
public static final Expression $minute
```

$mod
```
public static final Expression $mod
```

$month
```
public static final Expression $month
```

$multiply

public static final Expression $multiply

$ne
```
public static final Expression $ne
```

$not
```
public static final Expression $not
```

$objectToArray

public static final Expression $objectToArray

$or
```
public static final Expression $or
```

$pow
```
public static final Expression $pow
```

$range
```
public static final Expression $range
```

$reverseArray

public static final Expression $reverseArray

$second
```
public static final Expression $second
```

$setDifference

public static final Expression $setDifference

$setEquals

public static final Expression $setEquals

$setIntersection

public static final Expression $setIntersection

$setIsSubset

public static final Expression $setIsSubset

$setUnion

public static final Expression $setUnion

$size
```
public static final Expression $size
```

$slice
```
public static final Expression $slice
```

$split
```
public static final Expression $split
```

$subtract

public static final Expression $subtract

$sum
```
public static final Expression $sum
```

$sqrt
```
public static final Expression $sqrt
```

$toLower

public static final Expression $toLower

$toUpper

public static final Expression $toUpper

$toString

public static final Expression $toString

$trunc
```
public static final Expression $trunc
```

$year
```
public static final Expression $year
```

Method Detail

values
```
public static Expression[] values()
```
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Expression c : Expression.values())
    System.out.println(c);
```
Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf
```
public static Expression valueOf(java.lang.String name)
```
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

evaluateDocument

public static java.lang.Object evaluateDocument(java.lang.Object documentWithExpression,
                                                Document document)

name
```
public java.lang.String name()
```

requireSingleValue

public java.lang.Object requireSingleValue(java.util.List<?> list)

evaluateNumericValue

public java.lang.Number evaluateNumericValue(java.util.List<?> expressionValue,
                                             java.util.function.Function<java.lang.Double,? extends java.lang.Number> function)

evaluateComparison

public int evaluateComparison(java.util.List<?> expressionValue)

evaluateComparison

public boolean evaluateComparison(java.util.List<?> expressionValue,
                                  java.util.function.IntPredicate comparison)

evaluateDateTime

public <T> T evaluateDateTime(java.util.List<?> expressionValue,
                              java.util.function.Function<java.time.ZonedDateTime,T> dateFunction,
                              Document document)

evaluateDate

public <T> T evaluateDate(java.util.List<?> expressionValue,
                          java.util.function.Function<java.time.LocalDate,T> dateFunction,
                          Document document)

evaluateTime

public <T> T evaluateTime(java.util.List<?> expressionValue,
                          java.util.function.Function<java.time.LocalTime,T> timeFunction,
                          Document document)

requireCollectionInSize

public java.util.List<?> requireCollectionInSize(java.util.List<?> value,
                                                 int expectedCollectionSize)

requireTwoParameters

public de.bwaldvogel.mongo.backend.aggregation.TwoParameters requireTwoParameters(java.util.List<?> value)

requireTwoNumericParameters

public de.bwaldvogel.mongo.backend.aggregation.TwoNumericParameters requireTwoNumericParameters(java.util.List<?> value,
                                                                                                int errorCode)

getZonedDateTime

public java.time.ZonedDateTime getZonedDateTime(java.lang.Object value,
                                                Document document)

requireIntegral

public int requireIntegral(java.lang.Object value,
                           java.lang.String name)

evaluateIndexOf

public <T> java.lang.Object evaluateIndexOf(java.util.List<?> expressionValue,
                                            java.util.function.Function<java.lang.String,java.util.List<T>> toList,
                                            int errorCodeFirstParameterTypeMismatch,
                                            int errorCodeSecondParameterTypeMismatch)

requireArray

public java.util.Collection<?> requireArray(int errorCode,
                                            java.lang.Object value)

requireDocument

public Document requireDocument(java.lang.Object expressionValue,
                                int errorCode)

evaluateString

public java.lang.String evaluateString(java.util.List<?> expressionValue,
                                       java.util.function.Function<java.lang.String,java.lang.String> function)

Enum Expression

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

$abs

$add

$and

$anyElementTrue

$allElementsTrue

$arrayElemAt

$arrayToObject

$ceil

$cmp

$concat

$concatArrays

$cond

$dayOfMonth

$dayOfWeek

$dayOfYear

$divide

$eq

$exp

$filter

$floor

$gt

$gte

$hour

$ifNull

$in

$indexOfArray

$indexOfBytes

$indexOfCP

$isArray

$literal

$ln

$log

$log10

$lt

$lte

$map

$mergeObjects

$minute

$mod

$month

$multiply

$ne

$not

$objectToArray

$or

$pow

$range

$reverseArray

$second

$setDifference

$setEquals

$setIntersection

$setIsSubset

$setUnion

$size

$slice

$split

$subtract

$sum

$sqrt

$toLower

$toUpper

$toString

$trunc

$year

Method Detail

values

valueOf

evaluateDocument

name

requireSingleValue

evaluateNumericValue

evaluateComparison

evaluateComparison