com.oracle.iot.client.message

Class MessageProperties

java.lang.Object

com.oracle.iot.client.message.MessageProperties

public final class MessageProperties
extends java.lang.Object

MessageProperties contains a table of key and list of values pairs for extra information to send. This class is immutable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageProperties.Builder MessagePropertiesBuilder is the builder for MessageProperties.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Check if the properties contain the key.
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllProperties() Get all properties.
java.util.Set<java.lang.String>	getKeys() Get a Set of the keys.
java.util.List<java.lang.String>	getProperties(java.lang.String key) Get a List of values for a particular key.
java.lang.String	getProperty(java.lang.String key) Get the first value for a particular key.
java.lang.String	getProperty(java.lang.String key, int index) Get a specific value.
int	hashCode()
org.json.JSONObject	toJson() Method to export the message properties to JSONObject.
java.lang.String	toString() Method to print the message properties in JSON format.

Methods inherited from class java.lang.Object

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

Method Detail

containsKey

public final boolean containsKey(java.lang.String key)

Check if the properties contain the key.

Parameters:

key - property key

Returns:

true if the properties contain the key

getKeys

public final java.util.Set<java.lang.String> getKeys()

Get a Set of the keys.

Returns:

a set of the keys, never null.

getProperties

public final java.util.List<java.lang.String> getProperties(java.lang.String key)

Get a List of values for a particular key.

Parameters:

key - property key

Returns:

a List of String values

getProperty

public final java.lang.String getProperty(java.lang.String key)

Get the first value for a particular key.

Parameters:

key - property key

Returns:

value, may return null if the key does not exist or values assigned to this key is empty.

getProperty

public final java.lang.String getProperty(java.lang.String key,
                                          int index)

Get a specific value.

Parameters:

key - property key

index - index of the List of the String values

Returns:

value, may return null if the key does not exist or index is out of range.

getAllProperties

public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllProperties()

Get all properties.

Returns:

a Map of key and list of values, never null

toString

public final java.lang.String toString()

Method to print the message properties in JSON format.

Overrides:

toString in class java.lang.Object

Returns:

message properties in string format

toJson

public final org.json.JSONObject toJson()

Method to export the message properties to JSONObject.

Returns:

message properties in JSON format

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