Resource (cococlientsdk-java 0.28.2 API)

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

All Implemented Interfaces:

java.lang.Iterable<Capability>
```
public class Resource
extends java.lang.Object
implements java.lang.Iterable<Capability>
```
Resources are physical products such as bulbs, fans, temperature sensors, sprinklers to name a few. Resource can be added using Device.AddResource, removed using Device.RemoveResource resource and force removed using Device.ForceRemoveResource in case if the resource is broken or lost. Resources by default are added to Default zone. Resources can be moved from one Zone to another zone using Network.moveResources(Zone, Zone, Resource[], Network.NetworkManagementStatusListener)
Resource class acts as blueprint for resource belonging to a device. This class encapsulates all information about a resource such as id, name, manufacturer, power source, protocol, parent device, parent zone and capability map etc.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Resource(java.lang.String eui, Device parentDevice, Zone parentZone)
The constructor is protected.

Constructors
Modifier	Constructor and Description
`protected`	`Resource(java.lang.String eui, Device parentDevice, Zone parentZone)` The constructor is protected.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsCapability(Capability.CapabilityId capabilityId)` This function assists in checking membership of capability in capability map.
`<T extends Attribute> T`	`getAttribute(Capability.AttributeId attrId)` This function is used to return the Attribute object for the given Attribute ID.
`<T extends Capability> T`	`getCapability(Capability.CapabilityId capId)` This function is used to return the capability with the given capabilityId.
`java.util.Map<Capability.CapabilityId,Capability>`	`getCapabilityMap()` This function is used to return the HashMap that the sdk uses to map the CapabilityId to the Capability Objects.
`java.lang.String`	`getFirmware()` This function is used to get the firmware version of the current resource.
`java.lang.String`	`getId()` This function is used to get the unique ID of the resource.
`java.lang.String`	`getManufacturer()` This function is used to get the manufacturer name of the resource.
`java.lang.String`	`getMetadata()` A function to get the metadata of the resource.
`java.lang.String`	`getModel()` This function is used to get the model name of the resource.
`java.lang.String`	`getName()` This function is used to get the name of the resource.
`<T extends Device> T`	`getParent()` This function is used to get the Parent device of the resource.
`<T extends Zone> T`	`getParentZone()` This function is used to get the Parent zone of the resource.
`PowerSource`	`getPowerSource()` This function is used to know how the resource is being powered.
`RadioProtocol`	`getProtocol()` A function to get protocol used by the use resource.
`ReceiverType`	`getReceiverType()` This function is used to get the receiver properties of the resource.
`int`	`hashCode()`
`protected void`	`internalAddCapability(Capability capability)` A function that would be triggered when a `Capability` is added.
`protected void`	`internalMarkAsReady()` A function that would be triggered to mark the resource ready.
`protected void`	`internalRemoveCapability(Capability.CapabilityId capabilityId)` A function that would be triggered when `Capability` is removed.
`protected void`	`internalRemoveResource()` A function that would be the triggered when this resource is removed.
`protected void`	`internalSetFirmware(java.lang.String firmware)` A function that would be triggered when `firmware` is updated.
`protected void`	`internalSetManufacturer(java.lang.String manufacturer)` A function that would be triggered when `manufacturer` is updated.
`protected void`	`internalSetMetadata(java.lang.String metadata)` A function that would be triggered when `metadata` is updated.
`protected void`	`internalSetModel(java.lang.String model)` A function that would be triggered when `model` is updated.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `name` is updated.
`protected void`	`internalSetParentDevice(Device parentDevice)` A function that would be triggered when `Device.parent` is updated.
`protected void`	`internalSetParentZone(Zone parentZone)` A function that would be triggered when `Device.parent` is updated.
`protected void`	`internalSetPowerSource(PowerSource powerSource)` A function that would be triggered when `powerSource` is updated.
`protected void`	`internalSetProtocol(RadioProtocol protocol)` A function that would be triggered when `protocol` is updated.
`protected void`	`internalSetReceiverType(ReceiverType receiverType)` A function that would be triggered when `ReceiverType` is updated.
`boolean`	`isReady()` A function to suggest if the current resource is dummy or not.
`java.util.Iterator<Capability>`	`iterator()`
`void`	`setMetadata(java.lang.String metadata, Device.DeviceManagementStatusListener listener)` A function to set the name of the current resource.
`void`	`setName(java.lang.String name, Device.DeviceManagementStatusListener listener)` A function to set the name of the current resource.
`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
  - Resource
```
protected Resource(java.lang.String eui,
                   Device parentDevice,
                   Zone parentZone)
```
    The constructor is protected. So, that the developer cannot create a resource for himself.
    
    Parameters:
    
    eui - The unique ID of the resource.
    
    parentDevice - The parent device which contains this resource.
    
    parentZone - The parent zone which contains this resource.
- Method Detail
  - getId
```
public final java.lang.String getId()
```
    This function is used to get the unique ID of the resource.
    
    Returns:
    
    String: The unique identifier of the resource. NOTE: This ID may collide with Ids from other devices.
  - getName
```
public java.lang.String getName()
```
    This function is used to get the name of the resource.
    
    Returns:
    
    String: The name of the Resource is returned.
  - setName
```
public void setName(java.lang.String name,
                    Device.DeviceManagementStatusListener listener)
```
    A function to set the name of the current resource.
```
   
     resource.setName(resourceName,
     (command, resourceImpacted, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     })
   
 
```
    Parameters:
    
    name - The name which has to be set.
    
    listener - The listener that will be triggered with callbacks.
  - getManufacturer
```
public java.lang.String getManufacturer()
```
    This function is used to get the manufacturer name of the resource.
    
    Returns:
    
    String: The name of the Manufacturer is returned.
  - getModel
```
public java.lang.String getModel()
```
    This function is used to get the model name of the resource.
    
    Returns:
    
    String: The Model of the resource.
  - getFirmware
```
public java.lang.String getFirmware()
```
    This function is used to get the firmware version of the current resource.
    
    Returns:
    
    String: The firmware of the resource.
  - getPowerSource
```
public PowerSource getPowerSource()
```
    This function is used to know how the resource is being powered.
    
    Returns:
    
    The enum indicating the PowerSource of the resource.
  - getReceiverType
```
public ReceiverType getReceiverType()
```
    This function is used to get the receiver properties of the resource.
    
    Returns:
    
    The enum indicating the ReceiverType of the resource.
  - getParent
```
public final <T extends Device> T getParent()
```
    This function is used to get the Parent device of the resource.
    
    Type Parameters:
    
    T - capture for casting.
    
    Returns:
    
    Device: The parent device of the resource.
  - getParentZone
```
public final <T extends Zone> T getParentZone()
```
    This function is used to get the Parent zone of the resource.
    
    Type Parameters:
    
    T - capture for casting.
    
    Returns:
    
    Zone: The parent Zone of the resource.
  - getMetadata
```
public java.lang.String getMetadata()
```
    A function to get the metadata of the resource. Metadata is specific to the sub cluster of the application. i.e., Specific to the developer.
    
    Returns:
    
    String: Metadata of the resource
  - setMetadata
```
public void setMetadata(java.lang.String metadata,
                        Device.DeviceManagementStatusListener listener)
```
    A function to set the name of the current resource.
    
    Parameters:
    
    metadata - The data which has to be stored.
    
    listener - The listener that will be triggered with callbacks.
  - getCapabilityMap
```
public java.util.Map<Capability.CapabilityId,Capability> getCapabilityMap()
```
    This function is used to return the HashMap that the sdk uses to map the CapabilityId to the Capability Objects. This function can be used to databind the sdk to the application. NOTE: This hashmap is for read-only any misuse may cause the program to misbehave and even crash.
    
    Returns:
    
    The key being the CapabilityId and the value being the Capability Object.
  - getCapability
```
public <T extends Capability> T getCapability(Capability.CapabilityId capId)
```
    This function is used to return the capability with the given capabilityId.
    
    Type Parameters:
    
    T - Class to which Capability has to be cast.
    
    Parameters:
    
    capId - Capability ID corresponding to Capability.
    
    Returns:
    
    capability of the resource with the given capabilityId
  - getAttribute
```
public <T extends Attribute> T getAttribute(Capability.AttributeId attrId)
```
    This function is used to return the Attribute object for the given Attribute ID.
    
    Type Parameters:
    
    T - Class to which Attribute has to be cast.
    
    Parameters:
    
    attrId - CapabilityLevel.AttributeId.
    
    Returns:
    
    Attribute of the resource with the given capabilityId and attributeId
  - containsCapability
```
public boolean containsCapability(Capability.CapabilityId capabilityId)
```
    This function assists in checking membership of capability in capability map.
    
    Parameters:
    
    capabilityId - identifier of the Capability
    
    Returns:
    
    true if capability exists in memory.
  - internalAddCapability
```
protected void internalAddCapability(Capability capability)
```
    A function that would be triggered when a Capability is added.
    
    Parameters:
    
    capability - capability that is added to the resource.
  - internalRemoveCapability
```
protected void internalRemoveCapability(Capability.CapabilityId capabilityId)
```
    A function that would be triggered when Capability is removed.
    
    Parameters:
    
    capabilityId - ID of the removed capability.
  - isReady
```
public boolean isReady()
```
    A function to suggest if the current resource is dummy or not.
    
    Returns:
    
    boolean: true if the object is *NOT* dummy, and the device is ready.
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when name is updated.
    
    Parameters:
    
    name - Updated name of the resource.
  - internalSetMetadata
```
protected void internalSetMetadata(java.lang.String metadata)
```
    A function that would be triggered when metadata is updated.
    
    Parameters:
    
    metadata - Updated metadata of the resource.
  - internalSetManufacturer
```
protected void internalSetManufacturer(java.lang.String manufacturer)
```
    A function that would be triggered when manufacturer is updated.
    
    Parameters:
    
    manufacturer - Updated manufacturer name.
  - internalSetModel
```
protected void internalSetModel(java.lang.String model)
```
    A function that would be triggered when model is updated.
    
    Parameters:
    
    model - Updated model.
  - internalSetFirmware
```
protected void internalSetFirmware(java.lang.String firmware)
```
    A function that would be triggered when firmware is updated.
    
    Parameters:
    
    firmware - Updated firmware version.
  - internalSetPowerSource
```
protected void internalSetPowerSource(PowerSource powerSource)
```
    A function that would be triggered when powerSource is updated.
    
    Parameters:
    
    powerSource - Updated power source of the resource.
  - internalSetReceiverType
```
protected void internalSetReceiverType(ReceiverType receiverType)
```
    A function that would be triggered when ReceiverType is updated.
    
    Parameters:
    
    receiverType - Updated ReceiverType of the resource.
  - internalSetParentDevice
```
protected void internalSetParentDevice(Device parentDevice)
```
    A function that would be triggered when Device.parent is updated.
    
    Parameters:
    
    parentDevice - Updated parent device.
  - internalSetParentZone
```
protected void internalSetParentZone(Zone parentZone)
```
    A function that would be triggered when Device.parent is updated.
    
    Parameters:
    
    parentZone - Updated parent zone.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that would be triggered to mark the resource ready.
  - internalSetProtocol
```
protected void internalSetProtocol(RadioProtocol protocol)
```
    A function that would be triggered when protocol is updated.
    
    Parameters:
    
    protocol - Updated protocol of the resource.
  - internalRemoveResource
```
protected void internalRemoveResource()
```
    A function that would be the triggered when this resource is removed.
  - getProtocol
```
public RadioProtocol getProtocol()
```
    A function to get protocol used by the use resource.
    
    Returns:
    
    RadioProtocol protocol used by the resource.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - iterator
```
public java.util.Iterator<Capability> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Capability>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Resource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Resource

Method Detail

getId

getName

setName

getManufacturer

getModel

getFirmware

getPowerSource

getReceiverType

getParent

getParentZone

getMetadata

setMetadata

getCapabilityMap

getCapability

getAttribute

containsCapability

internalAddCapability

internalRemoveCapability

isReady

internalSetName

internalSetMetadata

internalSetManufacturer

internalSetModel

internalSetFirmware

internalSetPowerSource

internalSetReceiverType

internalSetParentDevice

internalSetParentZone

internalMarkAsReady

internalSetProtocol

internalRemoveResource

getProtocol

hashCode

iterator

toString