com.onlyoffice.model.docbuilderservice

Enum DocBuilderResponse.Error

java.lang.Object

java.lang.Enum<DocBuilderResponse.Error>

com.onlyoffice.model.docbuilderservice.DocBuilderResponse.Error

All Implemented Interfaces:

Error, Serializable, Comparable<DocBuilderResponse.Error>

Enclosing class:

DocBuilderResponse

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATABASE Error while accessing the document generation result database (the error code is -6).
DOWNLOADING Error while downloading the document file to be generated (the error code is -4).
GENERATION Document generation error (the error code is -3).
TIMEOUT Generation timeout error (the error code is -2).
TOKEN Invalid token (the error code is -8).
UNKNOWN Unknown error (the error code is -1).

Field Summary

Fields

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

UNKNOWN

public static final DocBuilderResponse.Error UNKNOWN

Unknown error (the error code is -1).

TIMEOUT

public static final DocBuilderResponse.Error TIMEOUT

Generation timeout error (the error code is -2).

GENERATION

public static final DocBuilderResponse.Error GENERATION

Document generation error (the error code is -3).

DOWNLOADING

public static final DocBuilderResponse.Error DOWNLOADING

Error while downloading the document file to be generated (the error code is -4).

DATABASE

public static final DocBuilderResponse.Error DATABASE

Error while accessing the document generation result database (the error code is -6).

TOKEN

public static final DocBuilderResponse.Error TOKEN

Invalid token (the error code is -8).

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

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

Method Detail

values

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