Capability (cococlientsdk-java 0.28.2 API)

java.lang.Object
- buzz.getcoco.iot.Capability

All Implemented Interfaces:

java.lang.Iterable<Attribute>

Direct Known Subclasses:

CapabilityAirQualitySensing, CapabilityColor, CapabilityContactSensing, CapabilityDoorLock, CapabilityEnergyMetering, CapabilityFireSensing, CapabilityFluidLevelSensing, CapabilityHumiditySensing, CapabilityHvacControl, CapabilityIlluminance, CapabilityImageControl, CapabilityKeyPressSensing, CapabilityLevel, CapabilityMediaStreaming, CapabilityMotionSensing, CapabilityMotorControl, CapabilityNetworkConfiguration, CapabilityOccupancySensing, CapabilityOnOff, CapabilityPowerLevels, CapabilityRealTimePosition, CapabilityRemoteControl, CapabilitySnapshot, CapabilityStationaryPosition, CapabilityStorageConfig, CapabilityStorageControl, CapabilityTemperatureSensing, CapabilityTunnel, CapabilityVibrationSensing, CapabilityWarning, CapabilityWindowCovering
```
public abstract class Capability
extends java.lang.Object
implements java.lang.Iterable<Attribute>
```
Capabilities can be described as a functionality that resource can perform. For example typical capabilities for bulb would be CapabilityOnOff, CapabilityLevel.
Each capability might have one or more commands. Which can be executed using sendResourceCommand(Command, CommandStatusListener)
Capability class acts as blueprint for the Capability present in the resource. It encapsulates all commands and attributes it supports.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Capability.AttributeId` Super interface for all AttributeIds used by capability of a resource.
`static class`	`Capability.CapabilityId` Enum mapping all coco-standard capabilityIds and their corresponding capability IDProviders.
`static interface`	`Capability.CommandId` Super interface for all CommandIds in all child Capabilities.
`static interface`	`Capability.CommandStatusListener<T extends Capability.CommandId>` Listener to assist with status of the `sendResourceCommand(Command, CommandStatusListener)`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Capability(int id, Resource parent)
Constructor of the current class.

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`clearAndSetStandardCommandSet(int[] commands)` A function to clear current commands and set new one's.
`boolean`	`containsAttribute(Capability.AttributeId attributeId)` A function to check if this capability contains `Attribute` given the ID.
`protected boolean`	`containsAttribute(int attributeId)` A function to check if this capability contains `Attribute` given the ID.
`protected Command<? extends Capability.CommandId>`	`createCommand(int commandId, com.google.gson.JsonElement commandParams)` A function to create the command from the Json params.
`protected <T extends CommandIdInterface> CommandResponse.Args<T>`	`createCommandResponseArgs(T commandId, com.google.gson.JsonElement jsonResponse)` create response args for the command.
`protected abstract Command<? extends Capability.CommandId>`	`extendedCreateCommand(int commandId, com.google.gson.JsonElement commandParams)` A function to create the command from the Json params.
`<T extends Attribute> T`	`getAttribute(Capability.AttributeId attributeId)` This function is used to get the Attribute with the given ID.
`<T extends Attribute> T`	`getAttribute(int attributeId)` This function is used to get the Attribute with the given ID.
`java.util.Map<java.lang.Integer,Attribute>`	`getAttributeMap()` This function is used to return the HashMap that the sdk uses to map the integer id of the attribute to the Attribute Objects.
`CapabilityWrapper`	`getCapabilityWrapper()` A function to get `CapabilityWrapper`.
`Capability.CapabilityId`	`getId()` This function is used to get the unique id of the capability.
`java.lang.String`	`getName()` This function is used to get the Name of the capability.
`Resource`	`getParent()` This function is used to get the parent resource of the current capability.
`java.util.List<Capability.CommandId>`	`getSupportedCommands()` This function fetches the list of commands supported.
`int`	`hashCode()`
`protected <T extends Capability.CommandId> void`	`interceptCommand(Command<T> command)` A function that will get called before command being sent to device.
`protected void`	`internalAddAttribute(Attribute attribute)` A function that will would get triggered when a `Attribute` is added.
`protected void`	`internalMarkAsReady()` A function that would be triggered to make `Capability` this as ready.
`protected void`	`internalRemoveAttribute(int attributeId)` A function that would be triggered when a `Attribute` is removed.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `name` is updated.
`protected void`	`internalSetParent(Resource parent)` A function that would be triggered when parent of the capability updated.
`boolean`	`isReady()` A function to state if the current capability is updated from `NativeCallbacks.resourceCapabilityCallback(boolean, java.lang.String, long, java.lang.String, int, java.lang.String, int[], java.lang.Object)` or by any other way.
`java.util.Iterator<Attribute>`	`iterator()`
`<T extends Capability.CommandId> void`	`sendResourceCommand(Command<T> command, Capability.CommandStatusListener<T> listener)` sendCommands to the current capability.
`void`	`setCapabilityWrapper(CapabilityWrapper capabilityWrapper)` This function sets provided `CapabilityWrapper` object.
`boolean`	`supports(Capability.CommandId commandId)` This function checks if a command is supported or not, pass null to check if capability supports any commands at all.
`java.lang.String`	`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

- Constructor Detail
  - Capability
```
protected Capability(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
  - interceptCommand
```
protected <T extends Capability.CommandId> void interceptCommand(Command<T> command)
```
    A function that will get called before command being sent to device.
    
    Type Parameters:
    
    T - capture for casting.
    
    Parameters:
    
    command - Command which is being sent.
  - sendResourceCommand
```
public final <T extends Capability.CommandId> void sendResourceCommand(Command<T> command,
                                                                       Capability.CommandStatusListener<T> listener)
```
    sendCommands to the current capability.
```
   
   bulb
     .getCapability(Capability.CapabilityId.ON_OFF_CONTROL)
     .sendResourceCommand(new CapabilityOnOff.On(),
      (commandResponse, throwable) &#45;&gt; {
       if (null != throwable) {
         // success case.
      })
     });
   
 
```
    Type Parameters:
    
    T - capture for casting.
    
    Parameters:
    
    command - The command which is to be executed.
    
    listener - Callback of this interface will be triggered.
    
    See Also:
    
    implements a different approach
  - supports
```
public boolean supports(Capability.CommandId commandId)
```
    This function checks if a command is supported or not, pass null to check if capability supports any commands at all. NOTE: Check the overridden function also for a complete view.
    
    Parameters:
    
    commandId - The ID denoting the command to be sent.
    
    Returns:
    
    boolean: If the command is supported then True is returned.
  - getId
```
public final Capability.CapabilityId getId()
```
    This function is used to get the unique id of the capability.
    
    Returns:
    
    CapabilityId: The enum denoting what is the current capability. NOTE: This id may be the same across different resources.
  - getName
```
public final java.lang.String getName()
```
    This function is used to get the Name of the capability.
    
    Returns:
    
    String: The name of the current capability.
  - getParent
```
public final Resource getParent()
```
    This function is used to get the parent resource of the current capability.
    
    Returns:
    
    Resource: The parent Resource of the capability
  - getAttributeMap
```
public java.util.Map<java.lang.Integer,Attribute> getAttributeMap()
```
    This function is used to return the HashMap that the sdk uses to map the integer id of the attribute to the Attribute Objects. This function can be used to databind the sdk to the application.
    
    Returns:
    
    The key being the integer id of attribute and the value being the Attribute Object. NOTE: This hashmap is for read-only any misuse may cause the program to misbehave and even crash.
  - getAttribute
```
public <T extends Attribute> T getAttribute(int attributeId)
```
    This function is used to get the Attribute with the given ID.
    
    Type Parameters:
    
    T - Capture for casting.
    
    Parameters:
    
    attributeId - Attribute ID of the of required Attribute.
    
    Returns:
    
    Attribute of the given AttributeId
  - getAttribute
```
public <T extends Attribute> T getAttribute(Capability.AttributeId attributeId)
```
    This function is used to get the Attribute with the given ID.
    
    Type Parameters:
    
    T - Capture for casting
    
    Parameters:
    
    attributeId - AttributeId of required Attribute
    
    Returns:
    
    Attribute of the given AttributeId
  - containsAttribute
```
protected boolean containsAttribute(int attributeId)
```
    A function to check if this capability contains Attribute given the ID.
    
    Parameters:
    
    attributeId - ID of the Attribute which needs to be looked up.
    
    Returns:
    
    Flag representing whether capability has the Attribute.
  - containsAttribute
```
public boolean containsAttribute(Capability.AttributeId attributeId)
```
    A function to check if this capability contains Attribute given the ID.
    
    Parameters:
    
    attributeId - ID of the Attribute which needs to be looked up.
    
    Returns:
    
    Flag representing whether capability has the Attribute.
  - internalAddAttribute
```
protected void internalAddAttribute(Attribute attribute)
```
    A function that will would get triggered when a Attribute is added.
    
    Parameters:
    
    attribute - Attribute which is added to the capability.
  - internalRemoveAttribute
```
protected void internalRemoveAttribute(int attributeId)
```
    A function that would be triggered when a Attribute is removed.
    
    Parameters:
    
    attributeId - ID of attribute which is removed from the capability.
  - internalSetParent
```
protected void internalSetParent(Resource parent)
```
    A function that would be triggered when parent of the capability updated.
    
    Parameters:
    
    parent - Resource which is parent of the capability.
  - setCapabilityWrapper
```
public void setCapabilityWrapper(CapabilityWrapper capabilityWrapper)
```
    This function sets provided CapabilityWrapper object.
    
    Parameters:
    
    capabilityWrapper - instance of wrapper object.
  - getCapabilityWrapper
```
public CapabilityWrapper getCapabilityWrapper()
```
    A function to get CapabilityWrapper.
    
    Returns:
    
    CapabilityWrapper
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getSupportedCommands
```
public java.util.List<Capability.CommandId> getSupportedCommands()
```
    This function fetches the list of commands supported.
    
    Returns:
    
    commands supported
  - extendedCreateCommand
```
protected abstract Command<? extends Capability.CommandId> extendedCreateCommand(int commandId,
                                                                                 com.google.gson.JsonElement commandParams)
```
    A function to create the command from the Json params. NOTE: This must be only used by classes extending this class.
    
    Parameters:
    
    commandId - The int form of the commandId
    
    commandParams - The Json params that can form a command
    
    Returns:
    
    The command which is formed
  - createCommandResponseArgs
```
protected <T extends CommandIdInterface> CommandResponse.Args<T> createCommandResponseArgs(T commandId,
                                                                                           com.google.gson.JsonElement jsonResponse)
```
    create response args for the command.
    
    Type Parameters:
    
    T - Capture for casting.
    
    Parameters:
    
    commandId - The command ID which has to be responded
    
    jsonResponse - The response body
    
    Returns:
    
    The created args
    
    See Also:
    
    CommandResponse.Args
  - createCommand
```
protected Command<? extends Capability.CommandId> createCommand(int commandId,
                                                                com.google.gson.JsonElement commandParams)
```
    A function to create the command from the Json params.
    
    Parameters:
    
    commandId - The int form of the commandId
    
    commandParams - The Json params that can form a command
    
    Returns:
    
    The command which is formed
  - isReady
```
public boolean isReady()
```
    A function to state if the current capability is updated from NativeCallbacks.resourceCapabilityCallback(boolean, java.lang.String, long, java.lang.String, int, java.lang.String, int[], java.lang.Object) or by any other way.
    
    Returns:
    
    boolean: states if the current attribute is ready or not.
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when name is updated.
    
    Parameters:
    
    name - Updated name of the capability.
  - clearAndSetStandardCommandSet
```
protected void clearAndSetStandardCommandSet(int[] commands)
```
    A function to clear current commands and set new one's.
    
    Parameters:
    
    commands - commands which needs to set as the standard commands for the capability.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that would be triggered to make Capability this as ready.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<Attribute> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Attribute>

Class Capability

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Capability

Method Detail

interceptCommand

sendResourceCommand

supports

getId

getName

getParent

getAttributeMap

getAttribute

getAttribute

containsAttribute

containsAttribute

internalAddAttribute

internalRemoveAttribute

internalSetParent

setCapabilityWrapper

getCapabilityWrapper

hashCode

getSupportedCommands

extendedCreateCommand

createCommandResponseArgs

createCommand

isReady

internalSetName

clearAndSetStandardCommandSet

internalMarkAsReady

toString

iterator