Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.commands

Enum AckStatus

java.lang.Object

java.lang.Enum<AckStatus>

com.thecoderscorner.menu.remote.commands.AckStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AckStatus>

public enum AckStatus
extends java.lang.Enum<AckStatus>

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
ID_NOT_FOUND
INVALID_CREDENTIALS
SUCCESS
UNKNOWN_ERROR
VALUE_RANGE_WARNING	The credentials provided were incorrect

Method Summary

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

VALUE_RANGE_WARNING

public static final AckStatus VALUE_RANGE_WARNING

The credentials provided were incorrect

SUCCESS

public static final AckStatus SUCCESS

ID_NOT_FOUND

public static final AckStatus ID_NOT_FOUND

INVALID_CREDENTIALS

public static final AckStatus INVALID_CREDENTIALS

UNKNOWN_ERROR

public static final AckStatus UNKNOWN_ERROR

Method Detail

values

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

Returns:

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

valueOf

public static AckStatus valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

getStatusCode

public int getStatusCode()

isError

public boolean isError()