com.onlyoffice.model.common

Enum CommonResponse.Error

java.lang.Object

java.lang.Enum<CommonResponse.Error>

com.onlyoffice.model.common.CommonResponse.Error

All Implemented Interfaces:

Error, Serializable, Comparable<CommonResponse.Error>

Enclosing class:

CommonResponse

public static enum CommonResponse.Error
extends Enum<CommonResponse.Error>
implements Error

Defines the Document Server error codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTION Connection error (the error code is -99).
DOWNLOAD_RESULT Download result file error (the error code is -98).
HEALTHCHECK Healthcheck return false (the error code is -1).

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<Integer,CommonResponse.Error>	BY_CODE Defines a map of the Error objects with the common error codes.
private Integer	code Defines the error code.
private String	description Defines the error description.

Method Summary

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

Methods inherited from interface com.onlyoffice.model.common.Error

getCode, getDescription

Enum Constant Detail

HEALTHCHECK

public static final CommonResponse.Error HEALTHCHECK

Healthcheck return false (the error code is -1).

DOWNLOAD_RESULT

public static final CommonResponse.Error DOWNLOAD_RESULT

Download result file error (the error code is -98).

CONNECTION

public static final CommonResponse.Error CONNECTION

Connection error (the error code is -99).

Field Detail

code

private final Integer code

Defines the error code.

description

private final String description

Defines the error description.

BY_CODE

private static final Map<Integer,CommonResponse.Error> BY_CODE

Defines a map of the Error objects with the common error codes.

Method Detail

values

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

Returns:

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

valueOf

public static CommonResponse.Error 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

valueOfCode

public static CommonResponse.Error valueOfCode(Integer code)

Returns the enum constant of this type with the specified code. The integer must match exactly a code used to declare an enum constant in this type.

Parameters:

code - The code of the enum constant to be returned.

Returns:

The enum constant with the specified code.