com.unitech.lib.types.scanner

Enum BeeperVolume

java.lang.Object

java.lang.Enum<BeeperVolume>

com.unitech.lib.types.scanner.BeeperVolume

All Implemented Interfaces:

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

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

The BeeperVolume enum represents different volume levels for a beeper. Each volume level 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 volume level, and to get a volume level from its byte value. It also provides a method to get an array containing the names of the volume levels.

Enum Constant Summary

Enum Constants

Enum Constant and Description
high
low
medium
mute

Method Summary

Modifier and Type	Method and Description
static BeeperVolume	fromValue(int value) Gets a volume level from its byte value.
byte	getCode() Gets the byte value of the volume level.
static java.lang.String[]	names() Returns an array containing the names of the volume levels.
java.lang.String	toString() Returns the string message of the volume level.
byte	value() Gets the byte value of the volume level.
static BeeperVolume	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BeeperVolume[]	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

mute

public static final BeeperVolume mute

low

public static final BeeperVolume low

medium

public static final BeeperVolume medium

high

public static final BeeperVolume high

Method Detail

values

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

Returns:

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

valueOf

public static BeeperVolume 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 byte value()

Gets the byte value of the volume level.

Returns:

The byte value of the volume level.

getCode

public byte getCode()

Gets the byte value of the volume level.

Returns:

The byte value of the volume level.

toString

public java.lang.String toString()

Returns the string message of the volume level.

Overrides:

toString in class java.lang.Enum<BeeperVolume>

Returns:

The string message of the volume level.

fromValue

public static BeeperVolume fromValue(int value)
                              throws java.lang.IllegalArgumentException

Gets a volume level from its byte value.

Parameters:

value - The byte value of the volume level.

Returns:

The volume level associated with the byte value.

Throws:

java.lang.IllegalArgumentException - If the byte value does not correspond to any volume level.

names

public static java.lang.String[] names()

Returns an array containing the names of the volume levels.

Returns:

An array containing the names of the volume levels.