Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.commands

Enum Class AckStatus

java.lang.Object

java.lang.Enum<AckStatus>

com.thecoderscorner.menu.remote.commands.AckStatus

All Implemented Interfaces:

Serializable, Comparable<AckStatus>, java.lang.constant.Constable

public enum AckStatus
extends Enum<AckStatus>

An enumeration that represents all the possible status / error return codes from the remote.

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
ID_NOT_FOUND	The requested ID was not found
INVALID_CREDENTIALS	The credentials provided were incorrect
SUCCESS	The operation was successful
UNKNOWN_ERROR	There was an error that is not categorised.
VALUE_RANGE_WARNING	This is a warning that the value was out of range

Method Summary

Modifier and Type	Method	Description
String	getDescription()
int	getStatusCode()
boolean	isError()
static AckStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AckStatus[]	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

VALUE_RANGE_WARNING

public static final AckStatus VALUE_RANGE_WARNING

This is a warning that the value was out of range

SUCCESS

public static final AckStatus SUCCESS

The operation was successful

ID_NOT_FOUND

public static final AckStatus ID_NOT_FOUND

The requested ID was not found

INVALID_CREDENTIALS

public static final AckStatus INVALID_CREDENTIALS

The credentials provided were incorrect

UNKNOWN_ERROR

public static final AckStatus UNKNOWN_ERROR

There was an error that is not categorised.

Method Details

values

public static AckStatus[] 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 AckStatus 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

getDescription

public String getDescription()

Returns:

description of this status

getStatusCode

public int getStatusCode()

Returns:

the integer wire code for this status.

isError

public boolean isError()

Returns:

true if the status code is an error, otherwise false.