buzz.getcoco.iot

Class CapabilityDoorLock

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilityDoorLock

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilityDoorLock
extends Capability

This class describes Commands and Attributes for Door Lock Capability of a Resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilityDoorLock.AttributeId enum denoting various possible attributes of the CapabilityDoorLock.
static class	CapabilityDoorLock.ClearPin This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while clearing the pin of the user.
static class	CapabilityDoorLock.CommandId enum denoting the possible Commands that can be sent for CapabilityDoorLock.
static class	CapabilityDoorLock.GetLockStatus This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while fetching lock status command.
static class	CapabilityDoorLock.GetPinCode This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while getting pin of a user.
static class	CapabilityDoorLock.GetUserStatus This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while getting user status.
static class	CapabilityDoorLock.GetUserType This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while getting the type of user.
static class	CapabilityDoorLock.Lock This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending Lock command.
static class	CapabilityDoorLock.SetPin This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while setting pin code for a user.
static class	CapabilityDoorLock.SetUserStatus This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while setting user status.
static class	CapabilityDoorLock.SetUserType This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while changing the user type.
static class	CapabilityDoorLock.ToggleDoorLock This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending Toggle door lock command.
static class	CapabilityDoorLock.Unlock This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending Unlock command.
static class	CapabilityDoorLock.UserStatus possible values of user status for DoorLock capability.
static class	CapabilityDoorLock.UserType possible values of user type for DoorLock capability.

Nested classes/interfaces inherited from class buzz.getcoco.iot.Capability

Capability.CapabilityId, Capability.CommandStatusListener<T extends Capability.CommandId>

Field Summary

Fields

Modifier and Type	Field and Description
static Capability.CapabilityId	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapabilityDoorLock(int id, Resource parent) Constructor of the current class.

Method Summary

Modifier and Type	Method and Description
protected Command<? extends Capability.CommandId>	extendedCreateCommand(int primitiveCommandId, com.google.gson.JsonElement commandParams) A function to create the command from the Json params.
boolean	supports(Capability.CommandId commandId) This function is used to check if a command is supported by the capability or not.

Methods inherited from class buzz.getcoco.iot.Capability

clearAndSetStandardCommandSet, containsAttribute, containsAttribute, createCommand, createCommandResponseArgs, getAttribute, getAttribute, getAttributeMap, getCapabilityWrapper, getId, getName, getParent, getSupportedCommands, hashCode, interceptCommand, internalAddAttribute, internalMarkAsReady, internalRemoveAttribute, internalSetName, internalSetParent, isReady, iterator, sendResourceCommand, setCapabilityWrapper, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ID

public static final Capability.CapabilityId ID

Constructor Detail

CapabilityDoorLock

protected CapabilityDoorLock(int id,
                             Resource parent)

Constructor of the current class.

Parameters:

id - The unique id Of the capability

parent - The parent Resource of the capability.

Method Detail

supports

public boolean supports(Capability.CommandId commandId)

This function is used to check if a command is supported by the capability or not.

Overrides:

supports in class Capability

Parameters:

commandId - The Id denoting the command to be sent.

Returns:

boolean: If the command is supported then True is returned.

extendedCreateCommand

protected Command<? extends Capability.CommandId> extendedCreateCommand(int primitiveCommandId,
                                                                        com.google.gson.JsonElement commandParams)

A function to create the command from the Json params.

Specified by:

extendedCreateCommand in class Capability

Parameters:

primitiveCommandId - The int form of the commandId

commandParams - The Json params that can form a command

Returns:

The command which is formed