Attribute (cococlientsdk-java 0.28.2 API)

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

```
public class Attribute
extends java.lang.Object
```
Attribute model class is a structure of the attribute used by a capability of a resource.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Attribute.ApplianceInfo` Blue print for value of `CapabilityRemoteControl.AttributeId.APPLIANCE_LIST`.
`static class`	`Attribute.ApplianceInfoContainer` Container class for `Attribute.ApplianceInfo`.
`static class`	`Attribute.CapabilityAttributes` Class that describes the a attribute of capability of an appliance.
`static class`	`Attribute.CapabilityCommands` Class that describes capability and its supported commands of an appliance.
`static class`	`Attribute.DataType` An enum denoting the data type of the given attribute's values.
`static class`	`Attribute.HvacModeCurrentInfo` Class that describes current info of a mode for IR blaster / Air conditioner resource.
`static class`	`Attribute.HvacSettings` Blue print for value of `CapabilityHvacControl.AttributeId.MODE_SETTINGS`.
`static class`	`Attribute.ModesAttributeValue` Class that describes various settings a mode has to offer.
`static class`	`Attribute.ModesAttributeValueContainer` Class that acts as a container that can be used to serialize and deserialize the attribute value of `CapabilityHvacControl.AttributeId.SUPPORTED_MODES_ARR`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Attribute(int id, Capability parent)
The constructor of the current class.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getArrayLength()` This function can be used to get the length of the array IF AND ONLY IF THE CURRENT `dataType` is an array.
`java.lang.Boolean`	`getAsBoolean()` A function that return the current value of this `Attribute` as `Boolean`.
`boolean[]`	`getAsBooleanArr()` A function with a job to narrow the `currentValue` to boolean[] explicitly.
`java.lang.Number`	`getAsNumber()` A function to return the current value of this attribute as `Number`.
`java.lang.Number[]`	`getAsNumberArr()` A function with a job to narrow the `currentValue` to Number[] explicitly.
`java.lang.String`	`getAsString()` A function to get current value of this attribute as `String`.
`java.lang.String[]`	`getAsStringArr()` A function with a job to narrow the `currentValue` to String[] explicitly.
`java.lang.Object`	`getCurrentValue()` This function can be used to get the current value that the attribute can take.
`Attribute.DataType`	`getDataType()` This function can be used to get the dataType of the attribute.
`java.lang.Object`	`getDefaultValue()` This function can be used to get the default value that the attribute can take.
`java.lang.String`	`getDescription()` This function is used to get the description of the attribute.
`<T> T`	`getElement(int position)` A function to help with getting the items of the current value NOTE: Works only when `dataType` is an array.
`Capability.AttributeId`	`getId()` This function is used to get the AttributeId enum of the Attribute.
`int`	`getMapKey()` This function is used to get the integer Ids of the Attribute.
`long`	`getMaxReportingInterval()` This function is used to get the maxReporting time of an attribute.
`java.lang.Object`	`getMaxValue()` This function can be used to get the max value that the attribute can take.
`long`	`getMinReportingInterval()` This function is used to get the minReporting time of an attribute.
`java.lang.Object`	`getMinValue()` This function can be used to get the min value that the attribute can take.
`java.lang.String`	`getName()` This function is used to get the name of the attribute.
`Capability`	`getParent()` This function can be used to get the parent capability of the attribute.
`int`	`hashCode()`
`protected void`	`internalMarkAsReady()` A function that would be triggered by lower layers when attribute is ready.
`protected void`	`internalSetArrayLength(int arrayLength)` A function that would be triggered to update `arrayLength`.
`protected void`	`internalSetCurrentValue(java.lang.Object currentValue)` A function that would be triggered when attribute's `currentValue` needs to be updated.
`protected void`	`internalSetDataType(int dataType)` A function that would be triggered when attribute's `dataType` needs to be updated.
`protected void`	`internalSetDefaultValue(java.lang.Object defaultValue)` A function that would be triggered when attribute `defaultValue` needs to be updated.
`protected void`	`internalSetDescription(java.lang.String description)` A function that would be triggered when attribute's `description` needs to be updated.
`protected void`	`internalSetMaxReportingInterval(long maxReportingInterval)` A function that would be triggered when attribute's `maxReportingInterval` needs to be updated.
`protected void`	`internalSetMaxValue(java.lang.Object maxValue)` A function that would be triggered when attribute' `maxValue` needs to be updated.
`protected void`	`internalSetMinReportingInterval(long minReportingInterval)` A function that would be triggered when attribute's `minReportingInterval` needs to be updated.
`protected void`	`internalSetMinValue(java.lang.Object minValue)` A function that would be triggered when attribute's `minValue` needs to be updated.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when attribute name needs to be updated.
`protected void`	`internalSetParent(Capability parent)` A function that would be triggered when parent of that attributes needs to be updated.
`protected void`	`internalSetRealtimeUpdate(boolean isRealTimeUpdate)` A function that would be triggered when attributes `isRealTimeUpdate` needs to be updated.
`boolean`	`isBooleanValue()` A function to determine if the current value of the string is `Boolean`.
`boolean`	`isNumberValue()` A function to determine if the current value of the attribute is `Number`.
`boolean`	`isReady()` A function to state if the current attribute is made from callbacks or state retrieval.
`boolean`	`isRealTimeUpdate()` A function to determine if current value of this attribute is value sent by `Resource`.
`boolean`	`isStringValue()` A function to determine if the current value of the string is `String`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Attribute
```
protected Attribute(int id,
                    Capability parent)
```
    The constructor of the current class.
    
    Parameters:
    
    id - The unique ID of the attribute.
    
    parent - The parent capability of the attribute
- Method Detail
  - getMapKey
```
public final int getMapKey()
```
    This function is used to get the integer Ids of the Attribute.
    
    Returns:
    
    int: The Integer ID of the Attribute.
  - getId
```
public final Capability.AttributeId getId()
```
    This function is used to get the AttributeId enum of the Attribute.
    
    Returns:
    
    Capability.AttributeId: The return value can be directly compared to attributeIds present in capability's child classes.
  - getName
```
public java.lang.String getName()
```
    This function is used to get the name of the attribute.
    
    Returns:
    
    String: The name of the attribute.
  - getDescription
```
public java.lang.String getDescription()
```
    This function is used to get the description of the attribute.
    
    Returns:
    
    String: The description of the attribute is returned.
  - getDataType
```
public Attribute.DataType getDataType()
```
    This function can be used to get the dataType of the attribute.
    
    Returns:
    
    DataType: The enum denoting the dataType of the attribute. i.e., The datatype to of current, min, max, default values.
  - getMinValue
```
public java.lang.Object getMinValue()
```
    This function can be used to get the min value that the attribute can take.
    
    Returns:
    
    Object: This can be typecast to different values by using the getDataType().
  - getMaxValue
```
public java.lang.Object getMaxValue()
```
    This function can be used to get the max value that the attribute can take.
    
    Returns:
    
    Object: This can be typecast to different values by using the getDataType().
  - getDefaultValue
```
public java.lang.Object getDefaultValue()
```
    This function can be used to get the default value that the attribute can take.
    
    Returns:
    
    Object: This can be typecast to different values by using the getDataType().
  - getCurrentValue
```
public java.lang.Object getCurrentValue()
```
    This function can be used to get the current value that the attribute can take.
    
    Returns:
    
    Object: This can be typecast to different values by using the getDataType().
  - getParent
```
public Capability getParent()
```
    This function can be used to get the parent capability of the attribute.
    
    Returns:
    
    Capability: The parent capability of the attribute.
  - getMaxReportingInterval
```
public long getMaxReportingInterval()
```
    This function is used to get the maxReporting time of an attribute.
    
    Returns:
    
    long: The max duration between two updates.
  - getMinReportingInterval
```
public long getMinReportingInterval()
```
    This function is used to get the minReporting time of an attribute.
    
    Returns:
    
    long: The min duration between two updates
  - getArrayLength
```
public int getArrayLength()
```
    This function can be used to get the length of the array IF AND ONLY IF THE CURRENT dataType is an array.
    
    Returns:
    
    The length of the array, if dataType is an array
  - getElement
```
public <T> T getElement(int position)
```
    A function to help with getting the items of the current value NOTE: Works only when dataType is an array.
    
    Type Parameters:
    
    T - Data type of element.
    
    Parameters:
    
    position - The position of the item.
    
    Returns:
    
    The object at the index position
  - isRealTimeUpdate
```
public final boolean isRealTimeUpdate()
```
    A function to determine if current value of this attribute is value sent by Resource.
    
    Returns:
    
    Boolean: A flag that represents if current value of attribute is cached value send by Device.
  - internalSetRealtimeUpdate
```
protected final void internalSetRealtimeUpdate(boolean isRealTimeUpdate)
```
    A function that would be triggered when attributes isRealTimeUpdate needs to be updated.
    
    Parameters:
    
    isRealTimeUpdate - An updated flag that represents if current value of attribute is cached value send by Device.
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when attribute name needs to be updated.
    
    Parameters:
    
    name - The updated name of the attribute.
  - internalSetDescription
```
protected void internalSetDescription(java.lang.String description)
```
    A function that would be triggered when attribute's description needs to be updated.
    
    Parameters:
    
    description - The updated description of the attribute.
  - internalSetDataType
```
protected void internalSetDataType(int dataType)
```
    A function that would be triggered when attribute's dataType needs to be updated.
    
    Parameters:
    
    dataType - The updated datatype of the attribute.
  - internalSetArrayLength
```
protected void internalSetArrayLength(int arrayLength)
```
    A function that would be triggered to update arrayLength.
    
    Parameters:
    
    arrayLength - Length of the array.
  - internalSetMinValue
```
protected void internalSetMinValue(java.lang.Object minValue)
```
    A function that would be triggered when attribute's minValue needs to be updated.
    
    Parameters:
    
    minValue - The updated min value of the attribute.
  - internalSetMaxValue
```
protected void internalSetMaxValue(java.lang.Object maxValue)
```
    A function that would be triggered when attribute' maxValue needs to be updated.
    
    Parameters:
    
    maxValue - The updated max value of the attribute.
  - internalSetCurrentValue
```
protected void internalSetCurrentValue(java.lang.Object currentValue)
```
    A function that would be triggered when attribute's currentValue needs to be updated.
    
    Parameters:
    
    currentValue - The updated current value of the attribute.
  - internalSetDefaultValue
```
protected void internalSetDefaultValue(java.lang.Object defaultValue)
```
    A function that would be triggered when attribute defaultValue needs to be updated.
    
    Parameters:
    
    defaultValue - The updated default value of the attribute.
  - internalSetMinReportingInterval
```
protected void internalSetMinReportingInterval(long minReportingInterval)
```
    A function that would be triggered when attribute's minReportingInterval needs to be updated.
    
    Parameters:
    
    minReportingInterval - The updated minReportingInterval of the attribute.
  - internalSetMaxReportingInterval
```
protected void internalSetMaxReportingInterval(long maxReportingInterval)
```
    A function that would be triggered when attribute's maxReportingInterval needs to be updated.
    
    Parameters:
    
    maxReportingInterval - The updated maxReportingInterval of the attribute.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that would be triggered by lower layers when attribute is ready.
  - getAsString
```
public java.lang.String getAsString()
```
    A function to get current value of this attribute as String.
    
    Returns:
    
    String: Attribute value as String.
  - isStringValue
```
public boolean isStringValue()
```
    A function to determine if the current value of the string is String.
    
    Returns:
    
    Boolean: flag that represents if the current value of the attribute is string.
  - getAsNumber
```
public java.lang.Number getAsNumber()
```
    A function to return the current value of this attribute as Number.
    
    Returns:
    
    Number: Attribute value as Number.
  - isNumberValue
```
public boolean isNumberValue()
```
    A function to determine if the current value of the attribute is Number.
    
    Returns:
    
    Boolean: flag that represents if the current value of the attribute is Number.
  - isBooleanValue
```
public boolean isBooleanValue()
```
    A function to determine if the current value of the string is Boolean.
    
    Returns:
    
    Boolean: flag that represents if the current value of the attribute is Boolean.
  - getAsBoolean
```
public java.lang.Boolean getAsBoolean()
```
    A function that return the current value of this Attribute as Boolean.
    
    Returns:
    
    Boolean: Attribute value as Boolean.
  - getAsNumberArr
```
public java.lang.Number[] getAsNumberArr()
```
    A function with a job to narrow the currentValue to Number[] explicitly. NOTE: works only when dataType is int[], long[], float[] or double[]
    
    Returns:
    
    Number[]: Attribute value as array of Number objects.
  - getAsBooleanArr
```
public boolean[] getAsBooleanArr()
```
    A function with a job to narrow the currentValue to boolean[] explicitly.
    
    Returns:
    
    boolean[]: Attribute value as an array of boolean.
  - getAsStringArr
```
public java.lang.String[] getAsStringArr()
```
    A function with a job to narrow the currentValue to String[] explicitly.
    
    Returns:
    
    String[]: Attribute value as an array of string.
  - internalSetParent
```
protected void internalSetParent(Capability parent)
```
    A function that would be triggered when parent of that attributes needs to be updated.
    
    Parameters:
    
    parent - Updated Capability.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isReady
```
public boolean isReady()
```
    A function to state if the current attribute is made from callbacks or state retrieval.
    
    Returns:
    
    boolean: states if the current attribute is ready or not.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Attribute

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Attribute

Method Detail

getMapKey

getId

getName

getDescription

getDataType

getMinValue

getMaxValue

getDefaultValue

getCurrentValue

getParent

getMaxReportingInterval

getMinReportingInterval

getArrayLength

getElement

isRealTimeUpdate

internalSetRealtimeUpdate

internalSetName

internalSetDescription

internalSetDataType

internalSetArrayLength

internalSetMinValue

internalSetMaxValue

internalSetCurrentValue

internalSetDefaultValue

internalSetMinReportingInterval

internalSetMaxReportingInterval

internalMarkAsReady

getAsString

isStringValue

getAsNumber

isNumberValue

isBooleanValue

getAsBoolean

getAsNumberArr

getAsBooleanArr

getAsStringArr

internalSetParent

toString

isReady

hashCode