buzz.getcoco.iot

Enum CapabilityDoorLock.CommandId

java.lang.Object

java.lang.Enum<CapabilityDoorLock.CommandId>

buzz.getcoco.iot.CapabilityDoorLock.CommandId

All Implemented Interfaces:

Capability.CommandId, CommandIdInterface, java.io.Serializable, java.lang.Comparable<CapabilityDoorLock.CommandId>

Enclosing class:

CapabilityDoorLock

public static enum CapabilityDoorLock.CommandId
extends java.lang.Enum<CapabilityDoorLock.CommandId>
implements Capability.CommandId

enum denoting the possible Commands that can be sent for CapabilityDoorLock.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLEAR_PIN_CODE See CapabilityDoorLock.ClearPin.
GET_LOCK_STATUS See CapabilityDoorLock.GetLockStatus.
GET_PIN_CODE See CapabilityDoorLock.GetPinCode.
GET_USER_STATUS See CapabilityDoorLock.GetUserStatus.
GET_USER_TYPE See CapabilityDoorLock.GetUserType.
LOCK See CapabilityDoorLock.Lock.
SET_PIN_CODE See CapabilityDoorLock.SetPin.
SET_USER_STATUS See CapabilityDoorLock.SetUserStatus.
SET_USER_TYPE See CapabilityDoorLock.SetUserType.
TOGGLE_DOOR_LOCK See CapabilityDoorLock.ToggleDoorLock.
UNLOCK See CapabilityDoorLock.Unlock.

Method Summary

Modifier and Type	Method and Description
static CapabilityDoorLock.CommandId	getEnum(int index) A function to get Capability.CommandId given it's index.
int	getInt() A function to get ordinal value of enum.
static CapabilityDoorLock.CommandId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapabilityDoorLock.CommandId[]	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

LOCK

public static final CapabilityDoorLock.CommandId LOCK

See CapabilityDoorLock.Lock.

UNLOCK

public static final CapabilityDoorLock.CommandId UNLOCK

See CapabilityDoorLock.Unlock.

TOGGLE_DOOR_LOCK

public static final CapabilityDoorLock.CommandId TOGGLE_DOOR_LOCK

See CapabilityDoorLock.ToggleDoorLock.

SET_PIN_CODE

public static final CapabilityDoorLock.CommandId SET_PIN_CODE

See CapabilityDoorLock.SetPin.

CLEAR_PIN_CODE

public static final CapabilityDoorLock.CommandId CLEAR_PIN_CODE

See CapabilityDoorLock.ClearPin.

SET_USER_STATUS

public static final CapabilityDoorLock.CommandId SET_USER_STATUS

See CapabilityDoorLock.SetUserStatus.

SET_USER_TYPE

public static final CapabilityDoorLock.CommandId SET_USER_TYPE

See CapabilityDoorLock.SetUserType.

GET_LOCK_STATUS

public static final CapabilityDoorLock.CommandId GET_LOCK_STATUS

See CapabilityDoorLock.GetLockStatus.

GET_PIN_CODE

public static final CapabilityDoorLock.CommandId GET_PIN_CODE

See CapabilityDoorLock.GetPinCode.

GET_USER_STATUS

public static final CapabilityDoorLock.CommandId GET_USER_STATUS

See CapabilityDoorLock.GetUserStatus.

GET_USER_TYPE

public static final CapabilityDoorLock.CommandId GET_USER_TYPE

See CapabilityDoorLock.GetUserType.

Method Detail

values

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

Returns:

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

valueOf

public static CapabilityDoorLock.CommandId 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

getEnum

public static CapabilityDoorLock.CommandId getEnum(int index)

A function to get Capability.CommandId given it's index.

Parameters:

index - index of the required Capability.CommandId.

Returns:

Capability.CommandId at the given index.

getInt

public int getInt()

A function to get ordinal value of enum.

Specified by:

getInt in interface CommandIdInterface

Returns:

ordinal of enum