Attribute (cococlientsdk-java 0.22.3 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.DataType
An enum denoting the data type of the given attribute's values.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Attribute.DataType` An enum denoting the data type of the given attribute's values.

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()`
`boolean[]`	`getAsBooleanArr()` A function with a job to narrow the `currentValue` to boolean[] explicitly.
`java.lang.Number`	`getAsNumber()`
`java.lang.Number[]`	`getAsNumberArr()` A function with a job to narrow the `currentValue` to Number[] explicitly.
`java.lang.String`	`getAsString()`
`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()`
`protected void`	`internalSetArrayLength(int arrayLength)`
`protected void`	`internalSetCurrentValue(java.lang.Object currentValue)`
`protected void`	`internalSetDataType(int dataType)`
`protected void`	`internalSetDefaultValue(java.lang.Object defaultValue)`
`protected void`	`internalSetDescription(java.lang.String description)`
`protected void`	`internalSetMaxReportingInterval(long maxReportingInterval)`
`protected void`	`internalSetMaxValue(java.lang.Object maxValue)`
`protected void`	`internalSetMinReportingInterval(long minReportingInterval)`
`protected void`	`internalSetMinValue(java.lang.Object minValue)`
`protected void`	`internalSetName(java.lang.String name)`
`protected void`	`internalSetParent(Capability parent)`
`protected void`	`internalSetRealtimeUpdate(boolean isRealTimeUpdate)`
`boolean`	`isBooleanValue()`
`boolean`	`isNumberValue()`
`boolean`	`isReady()` A function to state if the current attribute is made from callbacks or state retrieval.
`boolean`	`isRealTimeUpdate()`
`boolean`	`isStringValue()`
`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.
    
    Parameters:
    
    position - The position of the item.
    
    Returns:
    
    The object at the index position
  - isRealTimeUpdate
```
public final boolean isRealTimeUpdate()
```
  - internalSetRealtimeUpdate
```
protected final void internalSetRealtimeUpdate(boolean isRealTimeUpdate)
```
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
  - internalSetDescription
```
protected void internalSetDescription(java.lang.String description)
```
  - internalSetDataType
```
protected void internalSetDataType(int dataType)
```
  - internalSetArrayLength
```
protected void internalSetArrayLength(int arrayLength)
```
  - internalSetMinValue
```
protected void internalSetMinValue(java.lang.Object minValue)
```
  - internalSetMaxValue
```
protected void internalSetMaxValue(java.lang.Object maxValue)
```
  - internalSetCurrentValue
```
protected void internalSetCurrentValue(java.lang.Object currentValue)
```
  - internalSetDefaultValue
```
protected void internalSetDefaultValue(java.lang.Object defaultValue)
```
  - internalSetMinReportingInterval
```
protected void internalSetMinReportingInterval(long minReportingInterval)
```
  - internalSetMaxReportingInterval
```
protected void internalSetMaxReportingInterval(long maxReportingInterval)
```
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
  - getAsString
```
public java.lang.String getAsString()
```
  - isStringValue
```
public boolean isStringValue()
```
  - getAsNumber
```
public java.lang.Number getAsNumber()
```
  - isNumberValue
```
public boolean isNumberValue()
```
  - isBooleanValue
```
public boolean isBooleanValue()
```
  - getAsBoolean
```
public java.lang.Boolean getAsBoolean()
```
  - 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)
```
  - 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