com.unitech.lib.types

Enum ResultCode

java.lang.Object

java.lang.Enum<ResultCode>

com.unitech.lib.types.ResultCode

All Implemented Interfaces:

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

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

Enum representing different result codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
busy The device is busy.
connectFail The connection to the device failed.
invalidAccessMode The specified access mode is invalid.
invalidDevice The specified device is invalid.
invalidEngine The specified engine is invalid.
invalidModule The specified module is invalid.
invalidParameter The specified parameter is invalid.
invalidProtocol The specified protocol is invalid.
invalidResponse The response from the device was invalid.
noACK No acknowledgement was received from the device.
noError No error occurred.
notConnected The device is not connected.
notSupported The requested operation is not supported.
operationCancelled The operation was cancelled.
outOfRange The requested operation is out of range.
readOnly The requested operation is read-only.
timeout The request timed out.
undefined The result code is undefined.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the integer code of the result code.
java.lang.String	toString() Returns the string representation of the result code.
int	value() Returns the integer value of the result code.
static ResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ResultCode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

noError

public static final ResultCode noError

No error occurred.

timeout

public static final ResultCode timeout

The request timed out.

noACK

public static final ResultCode noACK

No acknowledgement was received from the device.

connectFail

public static final ResultCode connectFail

The connection to the device failed.

notConnected

public static final ResultCode notConnected

The device is not connected.

invalidResponse

public static final ResultCode invalidResponse

The response from the device was invalid.

invalidModule

public static final ResultCode invalidModule

The specified module is invalid.

invalidDevice

public static final ResultCode invalidDevice

The specified device is invalid.

invalidEngine

public static final ResultCode invalidEngine

The specified engine is invalid.

invalidProtocol

public static final ResultCode invalidProtocol

The specified protocol is invalid.

invalidAccessMode

public static final ResultCode invalidAccessMode

The specified access mode is invalid.

invalidParameter

public static final ResultCode invalidParameter

The specified parameter is invalid.

notSupported

public static final ResultCode notSupported

The requested operation is not supported.

busy

public static final ResultCode busy

The device is busy.

readOnly

public static final ResultCode readOnly

The requested operation is read-only.

outOfRange

public static final ResultCode outOfRange

The requested operation is out of range.

operationCancelled

public static final ResultCode operationCancelled

The operation was cancelled.

undefined

public static final ResultCode undefined

The result code is undefined.

Method Detail

values

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

Returns:

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

valueOf

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

value

public int value()

Returns the integer value of the result code.

Returns:

The integer value of the result code.

getCode

public int getCode()

Returns the integer code of the result code.

Returns:

The integer code of the result code.

toString

public java.lang.String toString()

Returns the string representation of the result code.

Overrides:

toString in class java.lang.Enum<ResultCode>

Returns:

The string representation of the result code.