SetWindowFieldsOperation.RangeWindowBuilder (Spring Data MongoDB

java.lang.Object
- org.springframework.data.mongodb.core.aggregation.SetWindowFieldsOperation.RangeWindowBuilder

Enclosing class:

SetWindowFieldsOperation
```
public static class SetWindowFieldsOperation.RangeWindowBuilder
extends Object
```
Builder API for a SetWindowFieldsOperation.RangeWindow.

Author:

Christoph Strobl

Constructor Summary

Constructors
Constructor and Description

RangeWindowBuilder()

Constructors
Constructor and Description
`RangeWindowBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SetWindowFieldsOperation.RangeWindow`	`build()` Build the `SetWindowFieldsOperation.RangeWindow`.
`SetWindowFieldsOperation.RangeWindowBuilder`	`from(Number lower)` The lower (inclusive) range limit value to add to the value based on the sortBy field.
`SetWindowFieldsOperation.RangeWindowBuilder`	`from(String lower)` The lower (inclusive) range limit based on the sortBy field.
`SetWindowFieldsOperation.RangeWindowBuilder`	`fromCurrent()` Use current as `lower` limit.
`SetWindowFieldsOperation.RangeWindowBuilder`	`fromUnbounded()` Use unbounded as `lower` limit.
`SetWindowFieldsOperation.RangeWindowBuilder`	`to(Number upper)` The upper (inclusive) range limit value to add to the value based on the sortBy field.
`SetWindowFieldsOperation.RangeWindowBuilder`	`to(String upper)` The upper (inclusive) range limit based on the sortBy field.
`SetWindowFieldsOperation.RangeWindowBuilder`	`toCurrent()` Use current as `upper` limit.
`SetWindowFieldsOperation.RangeWindowBuilder`	`toUnbounded()` Use unbounded as `upper` limit.
`SetWindowFieldsOperation.RangeWindowBuilder`	`unit(SetWindowFieldsOperation.WindowUnit windowUnit)` Set the `unit` or measure for the given `SetWindowFieldsOperation.Window`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RangeWindowBuilder
```
public RangeWindowBuilder()
```
- Method Detail
  - from
```
public SetWindowFieldsOperation.RangeWindowBuilder from(String lower)
```
    The lower (inclusive) range limit based on the sortBy field.
    
    Parameters:
    
    lower - eg. current or unbounded.
    
    Returns:
    
    this.
  - to
```
public SetWindowFieldsOperation.RangeWindowBuilder to(String upper)
```
    The upper (inclusive) range limit based on the sortBy field.
    
    Parameters:
    
    upper - eg. current or unbounded.
    
    Returns:
    
    this.
  - from
```
public SetWindowFieldsOperation.RangeWindowBuilder from(Number lower)
```
    The lower (inclusive) range limit value to add to the value based on the sortBy field. Use a negative integer for a position before the current document. Use a positive integer for a position after the current document. 0 is the current document position.
    
    Parameters:
    
    lower -
    
    Returns:
    
    this.
  - to
```
public SetWindowFieldsOperation.RangeWindowBuilder to(Number upper)
```
    The upper (inclusive) range limit value to add to the value based on the sortBy field. Use a negative integer for a position before the current document. Use a positive integer for a position after the current document. 0 is the current document position.
    
    Parameters:
    
    upper -
    
    Returns:
    
    this.
  - fromCurrent
```
public SetWindowFieldsOperation.RangeWindowBuilder fromCurrent()
```
    Use current as lower limit.
    
    Returns:
    
    this.
  - fromUnbounded
```
public SetWindowFieldsOperation.RangeWindowBuilder fromUnbounded()
```
    Use unbounded as lower limit.
    
    Returns:
    
    this.
  - toCurrent
```
public SetWindowFieldsOperation.RangeWindowBuilder toCurrent()
```
    Use current as upper limit.
    
    Returns:
    
    this.
  - toUnbounded
```
public SetWindowFieldsOperation.RangeWindowBuilder toUnbounded()
```
    Use unbounded as upper limit.
    
    Returns:
    
    this.
  - unit
```
public SetWindowFieldsOperation.RangeWindowBuilder unit(SetWindowFieldsOperation.WindowUnit windowUnit)
```
    Set the unit or measure for the given SetWindowFieldsOperation.Window.
    
    Parameters:
    
    windowUnit - must not be null. Can be on of SetWindowFieldsOperation.Windows.
    
    Returns:
    
    this.
  - build
```
public SetWindowFieldsOperation.RangeWindow build()
```
    Build the SetWindowFieldsOperation.RangeWindow.
    
    Returns:
    
    new instance of SetWindowFieldsOperation.RangeWindow.

Class SetWindowFieldsOperation.RangeWindowBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RangeWindowBuilder

Method Detail

from

to

from

to

fromCurrent

fromUnbounded

toCurrent

toUnbounded

unit

build