oracle.iot.client.device

Class Data

java.lang.Object

oracle.iot.client.device.Data

public abstract class Data
extends java.lang.Object

Represents a set of custom data fields (key/value pairs) to be sent to the server. The custom data is sent by calling the submit() method. The time of the data fields are set when submit() is called, allowing submit() to be called more than once.

The set method returns the Data instance to allow fields of data to be set in fluent style.

See Also:

VirtualDevice.createData(String)

Method Summary

Modifier and Type	Method and Description
abstract <T> Data	set(java.lang.String field, T value) Set the value of a field in the Data.
abstract void	setOnError(AbstractVirtualDevice.ErrorCallback<VirtualDevice> callback) Set a callback that is invoked if an error occurs when submitting the Data.
abstract void	submit() Submit the data.

Methods inherited from class java.lang.Object

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

Method Detail

set

public abstract <T> Data set(java.lang.String field,
                             T value)

Set the value of a field in the Data. The fields are determined by the format given when the Data is created. The value is validated according to the constraints in the format. If the value is not valid, an IllegalArgumentException is raised.

All fields defined in the format that are "optional" : true must be set before calling submit().

Type Parameters:

T - the type of the value.

Parameters:

field - the name of a field from the custom data format

value - the value to set

Returns:

this Data instance

Throws:

java.lang.IllegalArgumentException - if the value is not valid, or field is null

See Also:

VirtualDevice.createData(String)

submit

public abstract void submit()

Submit the data. The event time is set when this method is called. The onError handler will be called if there is error sending the alert.

All fields defined in the format that are "optional" : true must be set before calling submit(). If submit() is called before setting all "optional" : true fields, an (unchecked) IllegalStateException is thrown.

Throws:

java.lang.IllegalStateException - if submit() is called before setting all "optional" : true fields

setOnError

public abstract void setOnError(AbstractVirtualDevice.ErrorCallback<VirtualDevice> callback)

Set a callback that is invoked if an error occurs when submitting the Data. The callback may be null, which will un-set the callback.

Parameters:

callback - a callback to invoke, or null