com.mongodb

Enum ErrorCategory

java.lang.Object

java.lang.Enum<ErrorCategory>

com.mongodb.ErrorCategory

All Implemented Interfaces:

Serializable, Comparable<ErrorCategory>

public enum ErrorCategory
extends Enum<ErrorCategory>

A categorization of errors returned by a MongoDB server command.

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DUPLICATE_KEY A duplicate key error
EXECUTION_TIMEOUT An execution timeout error
UNCATEGORIZED An uncategorized error

Method Summary

Modifier and Type	Method and Description
static ErrorCategory	fromErrorCode(int code) Translate an error code into an error category
static ErrorCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorCategory[]	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

UNCATEGORIZED

public static final ErrorCategory UNCATEGORIZED

An uncategorized error

DUPLICATE_KEY

public static final ErrorCategory DUPLICATE_KEY

A duplicate key error

MongoDB documentation

Unique Indexes

EXECUTION_TIMEOUT

public static final ErrorCategory EXECUTION_TIMEOUT

An execution timeout error

MongoDB documentation

maxTimeMS

Method Detail

values

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

Returns:

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

valueOf

public static ErrorCategory 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

fromErrorCode

public static ErrorCategory fromErrorCode(int code)

Translate an error code into an error category

Parameters:

code - the error code

Returns:

the error category for the given code