Package com.mongodb
Enum ErrorCategory
- java.lang.Object
-
- java.lang.Enum<ErrorCategory>
-
- com.mongodb.ErrorCategory
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ErrorCategory>
public enum ErrorCategory extends java.lang.Enum<ErrorCategory>
A categorization of errors returned by a MongoDB server command.- Since:
- 3.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DUPLICATE_KEY
A duplicate key errorEXECUTION_TIMEOUT
An execution timeout errorUNCATEGORIZED
An uncategorized error
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ErrorCategory
fromErrorCode(int code)
Translate an error code into an error categorystatic ErrorCategory
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
UNCATEGORIZED
public static final ErrorCategory UNCATEGORIZED
An uncategorized error
-
DUPLICATE_KEY
public static final ErrorCategory DUPLICATE_KEY
A duplicate key error
-
EXECUTION_TIMEOUT
public static final ErrorCategory EXECUTION_TIMEOUT
An execution timeout error
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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
-
-