Package com.mongodb.client.model

Enum Windows.Bound

java.lang.Object

java.lang.Enum<Windows.Bound>

com.mongodb.client.model.Windows.Bound

All Implemented Interfaces:

Serializable, Comparable<Windows.Bound>

Enclosing class:

Windows

@Beta
public static enum Windows.Bound
extends Enum<Windows.Bound>

Special values that may be used when specifying the bounds of a window.

Since:

4.3

Since server release

5.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT	The window bound is determined by the current document and is inclusive.
UNBOUNDED	The window bound is the same as the corresponding bound of the partition encompassing it.

Method Summary

Modifier and Type	Method	Description
static Windows.Bound	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Windows.Bound[]	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

CURRENT

public static final Windows.Bound CURRENT

The window bound is determined by the current document and is inclusive.

UNBOUNDED

public static final Windows.Bound UNBOUNDED

The window bound is the same as the corresponding bound of the partition encompassing it.

Method Detail

values

public static Windows.Bound[] 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 (Windows.Bound c : Windows.Bound.values())
    System.out.println(c);

Returns:

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

valueOf

public static Windows.Bound valueOf(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:

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

NullPointerException - if the argument is null