com.oracle.iot.client

Class DeviceModelFormat

java.lang.Object

com.oracle.iot.client.DeviceModelFormat

public abstract class DeviceModelFormat
extends java.lang.Object

DeviceModelFormat is the model of an message in a DeviceModel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceModelFormat.Field Describes a field of a message.
static class	DeviceModelFormat.Type The message type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceModelFormat()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDescription() A human friendly description of the message format.
abstract java.util.List<DeviceModelFormat.Field>	getFields() Get the format of fields.
abstract java.lang.String	getName() Get the message format name.
abstract DeviceModelFormat.Type	getType() The type of the message.
abstract java.lang.String	getURN() Get the URN of the message format

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceModelFormat

protected DeviceModelFormat()

Method Detail

getURN

public abstract java.lang.String getURN()

Get the URN of the message format

Returns:

the message format URN

getName

public abstract java.lang.String getName()

Get the message format name.

Returns:

the message format name

getDescription

public abstract java.lang.String getDescription()

A human friendly description of the message format. If the format does not contain a description, this method will return an empty String.

Returns:

the message format description, or an empty string

getType

public abstract DeviceModelFormat.Type getType()

The type of the message.

Returns:

the type of the message

getFields

public abstract java.util.List<DeviceModelFormat.Field> getFields()

Get the format of fields.

Returns:

list of field formats