Package com.mongodb.annotations

Enum Class Reason

java.lang.Object

java.lang.Enum<Reason>

com.mongodb.annotations.Reason

All Implemented Interfaces:

Serializable, Comparable<Reason>, java.lang.constant.Constable

@Beta(CLIENT)
public enum Reason
extends Enum<Reason>

Enumerates the reasons an API element might be marked with annotations like Alpha or Beta.

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
CLIENT	Indicates that the status of the driver API is the reason for the annotation.
SERVER	The driver API relies on the server API.

Method Summary

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

CLIENT

public static final Reason CLIENT

Indicates that the status of the driver API is the reason for the annotation.

SERVER

public static final Reason SERVER

The driver API relies on the server API. This dependency is the reason for the annotation and suggests that changes in the server API could impact the driver API.

Method Details

values

public static Reason[] 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 Reason 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