Package com.mongodb.client.model.mql

Enum Class MqlUnchecked.Unchecked

java.lang.Object

java.lang.Enum<MqlUnchecked.Unchecked>

com.mongodb.client.model.mql.MqlUnchecked.Unchecked

All Implemented Interfaces:

Serializable, Comparable<MqlUnchecked.Unchecked>, java.lang.constant.Constable

Enclosing class:

MqlUnchecked

public static enum MqlUnchecked.Unchecked
extends Enum<MqlUnchecked.Unchecked>

See Also:

• MqlUnchecked.value()

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PRESENT	The presence of the specified value is not checked by the API.
TYPE	The API relies on the values it encounters being of the (raw or non-parameterized) type implied, specified by, or inferred from the user code.
TYPE_ARGUMENT	The API checks the raw type, but relies on the type argument implied, specified by, or inferred from user code.

Method Summary

Modifier and Type	Method	Description
static MqlUnchecked.Unchecked	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MqlUnchecked.Unchecked[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TYPE

public static final MqlUnchecked.Unchecked TYPE

The API relies on the values it encounters being of the (raw or non-parameterized) type implied, specified by, or inferred from the user code.

For example, MqlDocument.getBoolean(String) relies on the values of the document field being of the boolean type.

TYPE_ARGUMENT

public static final MqlUnchecked.Unchecked TYPE_ARGUMENT

The API checks the raw type, but relies on the type argument implied, specified by, or inferred from user code.

For example, MqlValue.isArrayOr(MqlArray) checks that the value is of the array raw type, but relies on the elements of the array being of the type derived from the user code.

PRESENT

public static final MqlUnchecked.Unchecked PRESENT

The presence of the specified value is not checked by the API. The use of the annotated method is an unchecked assertion that the specified (whether by index, name, key, position, or otherwise) element is present in the structure involved.

For example, MqlDocument.getField(String) relies on the field being present, and MqlArray.first() relies on the array being non-empty.

Method Details

values

public static MqlUnchecked.Unchecked[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MqlUnchecked.Unchecked valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null