com.oracle.iot.client.message

Class DataItem<T>

java.lang.Object

com.oracle.iot.client.message.DataItem<T>

public final class DataItem<T>
extends java.lang.Object

DataItem is a key/value/type triplet for data in DataMessage along with the type of the data. Key cannot be null or empty, it is mandatory field. String value cannot be null, other values are primitive data types. Value is mandatory field. Type can be STRING, BOOLEAN or DOUBLE, see Type; it is assigned automatically by constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataItem.Type The data type of the data item.

Constructor Summary

Constructors

Constructor and Description
DataItem(java.lang.String key, boolean value) Constructor that takes String key and boolean value.
DataItem(java.lang.String key, double value) Constructor that takes String key and double value.
DataItem(java.lang.String key, java.lang.String value) Constructor that takes String key and String value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getKey() Get data item key.
DataItem.Type	getType() Get data item type.
T	getValue() Get data item value.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataItem

public DataItem(java.lang.String key,
                double value)

Constructor that takes String key and double value. This is to reinforce the value type.

Parameters:

key - data item key

value - data item double value

Throws:

java.lang.IllegalArgumentException - when value is Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY or Double.NaN or the key is empty or long string. Maximum length for key is Message.Utils.MAX_KEY_LENGTH bytes. The length is measured after the key is encoded using UTF-8 encoding.

java.lang.NullPointerException - when the key is null.

DataItem

public DataItem(java.lang.String key,
                boolean value)

Constructor that takes String key and boolean value. This is to reinforce the value type.

Parameters:

key - data item key

value - data item boolean value

Throws:

java.lang.IllegalArgumentException - when the key is empty or long string. Maximum length for key is Message.Utils.MAX_KEY_LENGTH bytes. The length is measured after the key is encoded using UTF-8 encoding.

java.lang.NullPointerException - when the key is null.

DataItem

public DataItem(java.lang.String key,
                java.lang.String value)

Constructor that takes String key and String value. This is to reinforce the value type

Parameters:

key - data item key

value - data item String value

Throws:

java.lang.IllegalArgumentException - when the key is empty, key or value are long strings. Maximum length for key is Message.Utils.MAX_KEY_LENGTH bytes, maximum length for value is Message.Utils.MAX_STRING_VALUE_LENGTH bytes. The length is measured after the string is encoded using UTF-8 encoding.

java.lang.NullPointerException - when the key or value are null.

Method Detail

getKey

public final java.lang.String getKey()

Get data item key.

Returns:

key of this DataItem, never null.

getValue

public final T getValue()

Get data item value.

Returns:

value of this DataItem, never null.

getType

public final DataItem.Type getType()

Get data item type.

Returns:

type of this DataItem, never null.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object