com.oracle.iot.client.message

Class MessageProperties.Builder

java.lang.Object

com.oracle.iot.client.message.MessageProperties.Builder

Enclosing class:

MessageProperties

public static final class MessageProperties.Builder
extends java.lang.Object

MessagePropertiesBuilder is the builder for MessageProperties.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MessageProperties.Builder	addValue(java.lang.String key, java.lang.String value) Add a new key/vale pair.
MessageProperties.Builder	addValues(java.lang.String key, java.util.List<java.lang.String> values) Add a new key/values pair.
MessageProperties	build() Creates new instance of MessageProperties using values from MessageProperties.Builder.
MessageProperties.Builder	copy(MessageProperties properties) Copy another MessageProperties by adding all properties to the current MessageProperties

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

addValue

public final MessageProperties.Builder addValue(java.lang.String key,
                                                java.lang.String value)

Add a new key/vale pair. If the key exists, add the value to the list of values. If the key does not exist, put the key and value to the table. Key or value cannot be null. Key cannot be empty. Key or value cannot be long strings. Maximum length for key is Message.Utils.MAX_KEY_LENGTH bytes, maximum length for value is Message.Utils.MAX_STRING_VALUE_LENGTH bytes. The length is measured after the string is encoded using UTF-8 encoding.

Parameters:

key - property key

value - property value

Returns:

MessageProperties.Builder

Throws:

java.lang.NullPointerException - for null key or the values are null.

java.lang.IllegalArgumentException - for empty or long key or for long value.

addValues

public final MessageProperties.Builder addValues(java.lang.String key,
                                                 java.util.List<java.lang.String> values)

Add a new key/values pair. If the key exists, adds the values to the list of existing values. If the key does not exist, puts the key and values to the table. Key or values cannot be null. Key cannot be empty or long string. Values cannot contain long strings. Maximum length for key is Message.Utils.MAX_KEY_LENGTH bytes, maximum length for any value is Message.Utils.MAX_STRING_VALUE_LENGTH bytes. The length is measured after the string is encoded using UTF-8 encoding.

Parameters:

key - property key

values - property values

Returns:

MessageProperties.Builder

Throws:

java.lang.NullPointerException - for null key or if the values are null or any item in values is null.

java.lang.IllegalArgumentException - for empty or long key and for any long item in values.

copy

public final MessageProperties.Builder copy(MessageProperties properties)

Copy another MessageProperties by adding all properties to the current MessageProperties

Parameters:

properties - MessageProperties to copy

Returns:

MessageProperties.Builder

build

public final MessageProperties build()

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

Returns:

Instance of MessageProperties