com.symbol.emdk.serialcomm

Enum SerialCommResults

java.lang.Object

java.lang.Enum<SerialCommResults>

com.symbol.emdk.serialcomm.SerialCommResults

All Implemented Interfaces:

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

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

Serial Communication error codes and its details.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_ENABLED The communication channel is already enabled.
COMM_PORT_IN_USE The serial communication port is already used by other instance.
DATA_SIZE_TOO_LARGE The number of bytes to write can't exceed maximum limit(4096 Bytes).
DEVICE_NOT_CONNECTED The remote device is not connected or attached to the mobile device.
DEVICE_NOT_READY Serial port is not ready to use.
EMDK_NOT_OPENED EMDK is not opened
FAILURE Failure
FEATURE_NOT_SUPPORTED The feature is not supported.
INVALID_OBJECT The object is not valid.
INVALID_VALUE Invalid value.
NOT_ENABLED The communication channel is not enabled.
READ_ONLY_SIGNAL The requested signal settings is read only.
SIGNAL_OUT_OF_RANGE The signal is out of range.
SUCCESS Success
UNDEFINED Error code not defined.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description for the error.
int	getValue() This method provides integer value assigned to the enum.
static SerialCommResults	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SerialCommResults[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final SerialCommResults SUCCESS

Success

FAILURE

public static final SerialCommResults FAILURE

Failure

INVALID_VALUE

public static final SerialCommResults INVALID_VALUE

Invalid value.

DEVICE_NOT_CONNECTED

public static final SerialCommResults DEVICE_NOT_CONNECTED

The remote device is not connected or attached to the mobile device.

NOT_ENABLED

public static final SerialCommResults NOT_ENABLED

The communication channel is not enabled.

ALREADY_ENABLED

public static final SerialCommResults ALREADY_ENABLED

The communication channel is already enabled.

EMDK_NOT_OPENED

public static final SerialCommResults EMDK_NOT_OPENED

EMDK is not opened

FEATURE_NOT_SUPPORTED

public static final SerialCommResults FEATURE_NOT_SUPPORTED

The feature is not supported.

INVALID_OBJECT

public static final SerialCommResults INVALID_OBJECT

The object is not valid.

DEVICE_NOT_READY

public static final SerialCommResults DEVICE_NOT_READY

Serial port is not ready to use. Try later.

COMM_PORT_IN_USE

public static final SerialCommResults COMM_PORT_IN_USE

The serial communication port is already used by other instance.

DATA_SIZE_TOO_LARGE

public static final SerialCommResults DATA_SIZE_TOO_LARGE

The number of bytes to write can't exceed maximum limit(4096 Bytes).

READ_ONLY_SIGNAL

public static final SerialCommResults READ_ONLY_SIGNAL

The requested signal settings is read only.

SIGNAL_OUT_OF_RANGE

public static final SerialCommResults SIGNAL_OUT_OF_RANGE

The signal is out of range.

UNDEFINED

public static final SerialCommResults UNDEFINED

Error code not defined.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

This method provides integer value assigned to the enum. It is recommended only to get error for the UNDEFINED enums at runtime if required.

Returns:

getDescription

public java.lang.String getDescription()

Returns the description for the error.

Returns:

Returns error description.