Package dev.le_app.mcss_api_java

Enum Class LastBackupState

java.lang.Object

java.lang.Enum<LastBackupState>

dev.le_app.mcss_api_java.LastBackupState

All Implemented Interfaces:

Serializable, Comparable<LastBackupState>, Constable

public enum LastBackupState
extends Enum<LastBackupState>

The state of the last backup.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The backup has been cancelled
COMPLETED	The backup has finished successfully
FAILED	The backup has failed
IN_PROGRESS	The backup is running
NEVER_RUN	The backup has never run

Method Summary

Modifier and Type	Method	Description
static LastBackupState	findByVal(int abbr)	Gets the last backup state from the value.
int	getValue()	Gets associated value for the last backup state - Used for API requests.
static LastBackupState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LastBackupState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEVER_RUN

public static final LastBackupState NEVER_RUN

The backup has never run

IN_PROGRESS

public static final LastBackupState IN_PROGRESS

The backup is running

COMPLETED

public static final LastBackupState COMPLETED

The backup has finished successfully

FAILED

public static final LastBackupState FAILED

The backup has failed

CANCELLED

public static final LastBackupState CANCELLED

The backup has been cancelled

Method Details

values

public static LastBackupState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LastBackupState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Gets associated value for the last backup state - Used for API requests.

Returns:

The last backup state as INT.

findByVal

public static LastBackupState findByVal(int abbr)

Gets the last backup state from the value.

Parameters:

abbr - The value to get the last backup state from.

Returns:

The last backup state.