com.unitech.lib.engine.types

Enum GoodReadIndicator

java.lang.Object

java.lang.Enum<GoodReadIndicator>

com.unitech.lib.engine.types.GoodReadIndicator

All Implemented Interfaces:

Serializable, Comparable<GoodReadIndicator>

public enum GoodReadIndicator
extends Enum<GoodReadIndicator>

The GoodReadIndicator enum represents different types of good read indicators. Each good read indicator is associated with a unique byte value and a descriptive string message. The enum also provides methods to get the byte value and string message of a good read indicator, and to get a good read indicator from its byte value. It also provides a method to get an array containing the names of the good read indicators.

Enum Constant Summary

Enum Constants

Enum Constant and Description
beeper
beeperVibrator
none
vibrator

Method Summary

Modifier and Type	Method and Description
static GoodReadIndicator	fromValue(byte value) Gets a good read indicator from its byte value.
byte	getCode() Gets the byte value of the good read indicator.
static String[]	names() Returns an array containing the names of the good read indicator constants.
String	toString() Returns the string message of the good read indicator.
static GoodReadIndicator	valueOf(String name) Returns the enum constant of this type with the specified name.
static GoodReadIndicator[]	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

none

public static final GoodReadIndicator none

beeper

public static final GoodReadIndicator beeper

vibrator

public static final GoodReadIndicator vibrator

beeperVibrator

public static final GoodReadIndicator beeperVibrator

Method Detail

values

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

Returns:

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

valueOf

public static GoodReadIndicator valueOf(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:

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

NullPointerException - if the argument is null

getCode

public byte getCode()

Gets the byte value of the good read indicator.

Returns:

The byte value of the good read indicator.

toString

public String toString()

Returns the string message of the good read indicator.

Overrides:

toString in class Enum<GoodReadIndicator>

Returns:

The string message of the good read indicator.

fromValue

public static GoodReadIndicator fromValue(byte value)
                                   throws IllegalArgumentException

Gets a good read indicator from its byte value.

Parameters:

value - The byte value of the good read indicator.

Returns:

The good read indicator associated with the byte value.

Throws:

IllegalArgumentException - If the byte value does not correspond to any good read indicator.

names

public static String[] names()

Returns an array containing the names of the good read indicator constants.

Returns:

An array containing the names of the good read indicator constants.