com.oracle.iot.client.message

Class DataMessage.Builder

java.lang.Object

com.oracle.iot.client.message.Message.MessageBuilder<DataMessage.Builder>

com.oracle.iot.client.message.DataMessage.Builder

Enclosing class:

DataMessage

public static final class DataMessage.Builder
extends Message.MessageBuilder<DataMessage.Builder>

DataMessage.Builder extends Message.MessageBuilder class. DataMessage class is immutable. A DataMessage.Builder is required when creating DataMessage. DataMessage uses Builder design pattern.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DataMessage	build() Creates new instance of DataMessage using values from DataMessage.Builder.
<T> DataMessage.Builder	dataItem(java.lang.String key, boolean value) Add boolean DataItem.
<T> DataMessage.Builder	dataItem(java.lang.String key, double value) Add double DataItem.
<T> DataMessage.Builder	dataItem(java.lang.String key, java.lang.String value) Add String DataItem.
<T> DataMessage.Builder	dataItems(java.util.Collection<DataItem<?>> dataItems) Add all DataItems to existing ones.
DataMessage.Builder	format(java.lang.String format) Set message format.
DataMessage.Builder	fromJson(org.json.JSONObject jsonObject) Method to deserialization of the Message from a JsonObject.
protected DataMessage.Builder	self() Returns current instance of DataMessage.Builder.

Methods inherited from class com.oracle.iot.client.message.Message.MessageBuilder

clientId, destination, diagnostic, direction, eventTime, eventTime, id, priority, properties, receivedTime, reliability, sender, sentTime, source

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

fromJson

public DataMessage.Builder fromJson(org.json.JSONObject jsonObject)

Description copied from class: Message.MessageBuilder

Method to deserialization of the Message from a JsonObject.

Overrides:

fromJson in class Message.MessageBuilder<DataMessage.Builder>

Parameters:

jsonObject - the jsonObject to fromString

Returns:

generic type of message builder

format

public final DataMessage.Builder format(java.lang.String format)

Set message format.

Parameters:

format - Format for the DataMessage

Returns:

Builder with updated format field.

dataItem

public final <T> DataMessage.Builder dataItem(java.lang.String key,
                                              double value)

Add double DataItem. Key cannot be null, empty or long String.

Type Parameters:

T - builder

Parameters:

key - String item key.

value - double item value.

Returns:

Builder with added new dataItem field.

Throws:

java.lang.IllegalArgumentException - when value is Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, Double.NaN or the key is empty or long string.

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

dataItem

public final <T> DataMessage.Builder dataItem(java.lang.String key,
                                              boolean value)

Add boolean DataItem. Key cannot be null, empty or long String.

Type Parameters:

T - builder

Parameters:

key - String item key

value - boolean item value

Returns:

Builder with added new dataItem field.

Throws:

java.lang.IllegalArgumentException - when the key is empty or long string.

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

dataItem

public final <T> DataMessage.Builder dataItem(java.lang.String key,
                                              java.lang.String value)

Add String DataItem. Key cannot be null, empty or long String. Value cannot be long String.

Type Parameters:

T - builder

Parameters:

key - String item key.

value - String item value.

Returns:

Builder with added new dataItem field.

Throws:

java.lang.IllegalArgumentException - when the key is empty, key or value are long strings.

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

dataItems

public final <T> DataMessage.Builder dataItems(java.util.Collection<DataItem<?>> dataItems)

Add all DataItems to existing ones.

Type Parameters:

T - builder

Parameters:

dataItems - Collection of DataItem.

Returns:

Builder with added new dataItem field.

build

public final DataMessage build()

Creates new instance of DataMessage using values from DataMessage.Builder.

Specified by:

build in class Message.MessageBuilder<DataMessage.Builder>

Returns:

Instance of DataMessage

self

protected final DataMessage.Builder self()

Returns current instance of DataMessage.Builder.

Specified by:

self in class Message.MessageBuilder<DataMessage.Builder>

Returns:

Instance of DataMessage.Builder