Package com.mongodb.client.model.mql

Interface MqlInteger

All Superinterfaces:

MqlNumber, MqlValue

@Sealed
@Beta(CLIENT)
public interface MqlInteger
extends MqlNumber

An integer value in the context of the MongoDB Query Language (MQL). Integers are a subset of numbers, and so, for example, the integer 0 and the number 0 are equal.

Since:

4.9.0

Method Summary

Modifier and Type	Method	Description
MqlInteger	abs()	The absolute value of this value.
default MqlInteger	add(int other)	The sum of adding this and the other value.
MqlInteger	add(MqlInteger other)	The sum of adding this and the other value.
MqlInteger	max(MqlInteger other)	The larger value of this and the other value.
MqlDate	millisecondsAsDate()	The date corresponding to this value when taken to be the number of milliseconds since the Unix epoch.
MqlInteger	min(MqlInteger other)	The smaller value of this and the other value.
default MqlInteger	multiply(int other)	The product of multiplying this and the other value.
MqlInteger	multiply(MqlInteger other)	The product of multiplying this and the other value.
<R extends MqlValue> R	passIntegerTo(Function<? super MqlInteger,? extends R> f)	The result of passing this value to the provided function.
default MqlInteger	subtract(int other)	The difference of subtracting the other value from this.
MqlInteger	subtract(MqlInteger other)	The difference of subtracting the other value from this.
<R extends MqlValue> R	switchIntegerOn(Function<Branches<MqlInteger>,? extends BranchesTerminal<MqlInteger,? extends R>> mapping)	The result of applying the provided switch mapping to this value.

Methods inherited from interface com.mongodb.client.model.mql.MqlNumber

add, add, divide, divide, max, min, multiply, multiply, passNumberTo, round, round, subtract, subtract, switchNumberOn

Methods inherited from interface com.mongodb.client.model.mql.MqlValue

asString, eq, equals, gt, gte, isArrayOr, isBooleanOr, isDateOr, isDocumentOr, isIntegerOr, isMapOr, isNumberOr, isStringOr, lt, lte, ne, passTo, switchOn

Method Details

multiply

MqlInteger multiply(MqlInteger other)

The product of multiplying this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

multiply

default MqlInteger multiply(int other)

The product of multiplying this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

add

MqlInteger add(MqlInteger other)

The sum of adding this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

add

default MqlInteger add(int other)

The sum of adding this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

subtract

MqlInteger subtract(MqlInteger other)

The difference of subtracting the other value from this.

Parameters:

other - the other value.

Returns:

the resulting value.

subtract

default MqlInteger subtract(int other)

The difference of subtracting the other value from this.

Parameters:

other - the other value.

Returns:

the resulting value.

max

MqlInteger max(MqlInteger other)

The larger value of this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

min

MqlInteger min(MqlInteger other)

The smaller value of this and the other value.

Parameters:

other - the other value.

Returns:

the resulting value.

abs

MqlInteger abs()

The absolute value of this value.

Specified by:

abs in interface MqlNumber

Returns:

the resulting value.

millisecondsAsDate

MqlDate millisecondsAsDate()

The date corresponding to this value when taken to be the number of milliseconds since the Unix epoch.

Returns:

the resulting value.

Since server release

4.0

passIntegerTo

<R extends MqlValue> R passIntegerTo(Function<? super MqlInteger,? extends R> f)

The result of passing this value to the provided function. Equivalent to f.apply(this), and allows lambdas and static, user-defined functions to use the chaining syntax.

Type Parameters:

R - the type of the resulting value.

Parameters:

f - the function to apply.

Returns:

the resulting value.

See Also:

• MqlValue.passTo(java.util.function.Function<? super com.mongodb.client.model.mql.MqlValue, ? extends R>)

switchIntegerOn

<R extends MqlValue> R switchIntegerOn(Function<Branches<MqlInteger>,? extends BranchesTerminal<MqlInteger,? extends R>> mapping)

The result of applying the provided switch mapping to this value.

Type Parameters:

R - the type of the resulting value.

Parameters:

mapping - the switch mapping.

Returns:

the resulting value.

See Also:

• MqlValue.switchOn(java.util.function.Function<com.mongodb.client.model.mql.Branches<com.mongodb.client.model.mql.MqlValue>, ? extends com.mongodb.client.model.mql.BranchesTerminal<com.mongodb.client.model.mql.MqlValue, ? extends R>>)