com.onlyoffice.model.commandservice

Enum CommandResponse.Error

java.lang.Object

java.lang.Enum<CommandResponse.Error>

com.onlyoffice.model.commandservice.CommandResponse.Error

All Implemented Interfaces:

Error, Serializable, Comparable<CommandResponse.Error>

Enclosing class:

CommandResponse

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

Defines the Command Service error codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALLBACK_URL Callback url not correct (the error code is 2).
COMMAND Command not correct (the error code is 5).
FORCESAVE No changes were applied to the document before the forcesave command was received (the error code is 4).
INTERNAL_SERVER Internal server error (the error code is 3).
KEY Document key is missing or no document with such key could be found (the error code is 1).
NO No errors (the error code is 0).
TOKEN Invalid token (the error code is 6).

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<Integer,CommandResponse.Error>	BY_CODE Defines a map of the Error objects with the Command Service 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 CommandResponse.Error	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandResponse.Error	valueOfCode(Integer code) Returns the enum constant of this type with the specified code.
static CommandResponse.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

NO

public static final CommandResponse.Error NO

No errors (the error code is 0).

KEY

public static final CommandResponse.Error KEY

Document key is missing or no document with such key could be found (the error code is 1).

CALLBACK_URL

public static final CommandResponse.Error CALLBACK_URL

Callback url not correct (the error code is 2).

INTERNAL_SERVER

public static final CommandResponse.Error INTERNAL_SERVER

Internal server error (the error code is 3).

FORCESAVE

public static final CommandResponse.Error FORCESAVE

No changes were applied to the document before the forcesave command was received (the error code is 4).

COMMAND

public static final CommandResponse.Error COMMAND

Command not correct (the error code is 5).

TOKEN

public static final CommandResponse.Error TOKEN

Invalid token (the error code is 6).

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,CommandResponse.Error> BY_CODE

Defines a map of the Error objects with the Command Service error codes.

Method Detail

values

public static CommandResponse.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 (CommandResponse.Error c : CommandResponse.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 CommandResponse.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 CommandResponse.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.