com.onlyoffice.model.documenteditor.callback

Enum ForcesaveType

java.lang.Object

java.lang.Enum<ForcesaveType>

com.onlyoffice.model.documenteditor.callback.ForcesaveType

All Implemented Interfaces:

Serializable, Comparable<ForcesaveType>

public enum ForcesaveType
extends Enum<ForcesaveType>

Defines the type of initiator when the force saving request is performed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMAND_SERVICE The force saving request is performed to the command service (the type ID is 0).
SAVE_BUTTON The force saving request is performed each time the saving is done (e.g.
SUBMIT_FORM The force saving request is performed by submit form(the type ID is 3).
TIMER The force saving request is performed by timer with the settings from the server config (the type ID is 2).

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<Integer,ForcesaveType>	BY_ID Defines a map of the force saving request types with their IDs.
private int	id Defines the ID of the force saving request type.

Method Summary

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

COMMAND_SERVICE

public static final ForcesaveType COMMAND_SERVICE

The force saving request is performed to the command service (the type ID is 0).

SAVE_BUTTON

public static final ForcesaveType SAVE_BUTTON

The force saving request is performed each time the saving is done (e.g. the "Save" button is clicked), which is only available when the forcesave option is set to "true" (the type ID is 1).

TIMER

public static final ForcesaveType TIMER

The force saving request is performed by timer with the settings from the server config (the type ID is 2).

SUBMIT_FORM

public static final ForcesaveType SUBMIT_FORM

The force saving request is performed by submit form(the type ID is 3).

Field Detail

id

private final int id

Defines the ID of the force saving request type.

BY_ID

private static final Map<Integer,ForcesaveType> BY_ID

Defines a map of the force saving request types with their IDs.

Method Detail

values

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

Returns:

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

valueOf

public static ForcesaveType 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 ForcesaveType 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 ID of the force saving request type.

Returns:

The ID of the force saving request type.