buzz.getcoco.iot

Class Resource

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>

Resource class is blueprint of 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.

Method Summary

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 capability with the given .
<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()
ReceiverType	getReceiverType() This function is used to get the receiver properties of the resource.
int	hashCode()
protected void	internalAddCapability(Capability capability)
protected void	internalMarkAsReady()
protected void	internalRemoveCapability(Capability.CapabilityId capabilityId)
protected void	internalRemoveResource()
protected void	internalSetFirmware(java.lang.String firmware)
protected void	internalSetManufacturer(java.lang.String manufacturer)
protected void	internalSetMetadata(java.lang.String metadata)
protected void	internalSetModel(java.lang.String model)
protected void	internalSetName(java.lang.String name)
protected void	internalSetParentDevice(Device parentDevice)
protected void	internalSetParentZone(Zone parentZone)
protected void	internalSetPowerSource(PowerSource powerSource)
protected void	internalSetProtocol(RadioProtocol protocol)
protected void	internalSetReceiverType(ReceiverType receiverType)
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.

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.

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:

PowerSource: The enum indicating the power source of the resource.

getReceiverType

public ReceiverType getReceiverType()

This function is used to get the receiver properties of the resource.

Returns:

ReceiverType: The enum indicating the receiver type of the resource.

getParent

public final <T extends Device> T getParent()

This function is used to get the Parent device of the resource.

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.

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.

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 capability with the given .

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)

internalRemoveCapability

protected void internalRemoveCapability(Capability.CapabilityId capabilityId)

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)

internalSetMetadata

protected void internalSetMetadata(java.lang.String metadata)

internalSetManufacturer

protected void internalSetManufacturer(java.lang.String manufacturer)

internalSetModel

protected void internalSetModel(java.lang.String model)

internalSetFirmware

protected void internalSetFirmware(java.lang.String firmware)

internalSetPowerSource

protected void internalSetPowerSource(PowerSource powerSource)

internalSetReceiverType

protected void internalSetReceiverType(ReceiverType receiverType)

internalSetParentDevice

protected void internalSetParentDevice(Device parentDevice)

internalSetParentZone

protected void internalSetParentZone(Zone parentZone)

internalMarkAsReady

protected void internalMarkAsReady()

internalSetProtocol

protected void internalSetProtocol(RadioProtocol protocol)

internalRemoveResource

protected void internalRemoveResource()

getProtocol

public RadioProtocol getProtocol()

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