com.onlyoffice.model.documenteditor.callback

Enum Status

java.lang.Object

java.lang.Enum<Status>

com.onlyoffice.model.documenteditor.callback.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

Defines the status of the document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED The document is closed with no changes (the status ID is 4).
EDITING The document is being edited (the status ID is 1).
FORCESAVE The document is being edited, but the current document state is saved (the status ID is 6).
FORCESAVE_CORRUPTED The error has occurred while force saving the document (the status ID is 7).
SAVE The document is ready for saving (the status ID is 2).
SAVE_CORRUPTED The document saving error has occurred (the status ID is 3).

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<Integer,Status>	BY_ID Defines a map of the statuses with their IDs.
private int	id Defines the status ID.

Method Summary

Modifier and Type	Method and Description
(package private) int	getId() Returns the status ID.
static Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Status	valueOfId(Integer code) Returns the enum constant of this type with the specified ID.
static Status[]	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

EDITING

public static final Status EDITING

The document is being edited (the status ID is 1).

SAVE

public static final Status SAVE

The document is ready for saving (the status ID is 2).

SAVE_CORRUPTED

public static final Status SAVE_CORRUPTED

The document saving error has occurred (the status ID is 3).

CLOSED

public static final Status CLOSED

The document is closed with no changes (the status ID is 4).

FORCESAVE

public static final Status FORCESAVE

The document is being edited, but the current document state is saved (the status ID is 6).

FORCESAVE_CORRUPTED

public static final Status FORCESAVE_CORRUPTED

The error has occurred while force saving the document (the status ID is 7).

Field Detail

id

private final int id

Defines the status ID.

BY_ID

private static final Map<Integer,Status> BY_ID

Defines a map of the statuses with their IDs.

Method Detail

values

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

Returns:

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

valueOf

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

valueOfId

public static Status valueOfId(Integer code)

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

Parameters:

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

Returns:

The enum constant with the specified ID.

getId

int getId()

Returns the status ID.

Returns:

The status ID.