com.oracle.iot.client.message

Class AlertMessage.Builder

java.lang.Object

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

com.oracle.iot.client.message.AlertMessage.Builder

Enclosing class:

AlertMessage

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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 AlertMessage.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<AlertMessage.Builder>

Parameters:

jsonObject - the jsonObject to fromString

Returns:

generic type of message builder

severity

public final AlertMessage.Builder severity(AlertMessage.Severity severity)

Set alert severity

Parameters:

severity - the severity for the (@link AlertMessage}

Returns:

Builder with update severity field

description

public final AlertMessage.Builder description(java.lang.String description)

Set the description for the alert

Parameters:

description - description for the AlertMessage

Returns:

Builder with updated format field.

format

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

Set message format.

Parameters:

format - format for the AlertMessage

Returns:

Builder with updated format field.

dataItem

public final <T> AlertMessage.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> AlertMessage.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> AlertMessage.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> AlertMessage.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 AlertMessage build()

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

Specified by:

build in class Message.MessageBuilder<AlertMessage.Builder>

Returns:

Instance of AlertMessage

self

protected final AlertMessage.Builder self()

Returns current instance of AlertMessage.Builder.

Specified by:

self in class Message.MessageBuilder<AlertMessage.Builder>

Returns:

Instance of AlertMessage.Builder