com.microsoft.azure.sdk.iot.device

Class MessageProperty

java.lang.Object

com.microsoft.azure.sdk.iot.device.MessageProperty

public final class MessageProperty
extends Object

An IoT Hub message property.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name The property name.
static Set<String>	RESERVED_PROPERTY_NAMES A set of reserved property names.
protected String	value The property value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageProperty()
	MessageProperty(String name, String value) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the property name.
String	getValue() Returns the property value.
boolean	hasSameName(String name) Equivalent to property.getName().equalsIgnoreCase(name).
static boolean	isValidAppProperty(String name, String value) Returns whether the property is a valid application property.
protected static boolean	usesValidChars(String s) Returns true if the string only uses US-ASCII printable chars and does not contain: ()<>@,;:\"/[]?={} (space) (horizontal tab)

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_PROPERTY_NAMES

public static final Set<String> RESERVED_PROPERTY_NAMES

A set of reserved property names. The reserved property names are interpreted in a meaningful way by the device and the IoT Hub.

name

protected final String name

The property name.

value

protected final String value

The property value.

Constructor Detail

MessageProperty

public MessageProperty(String name,
                       String value)

Constructor.

Parameters:

name - The IoT Hub message property name.

value - The IoT Hub message property value.

Throws:

IllegalArgumentException - if the name and value constitute an invalid IoT Hub message property. A message property can only contain US-ASCII printable chars, with some exceptions as specified in RFC 2047. A message property name cannot be one of the reserved property names.

MessageProperty

protected MessageProperty()

Method Detail

getName

public String getName()

Returns the property name.

Returns:

the property name.

getValue

public String getValue()

Returns the property value.

Returns:

the property value.

hasSameName

public boolean hasSameName(String name)

Equivalent to property.getName().equalsIgnoreCase(name).

Parameters:

name - the property name.

Returns:

true if the given name is the property name.

isValidAppProperty

public static boolean isValidAppProperty(String name,
                                         String value)

Returns whether the property is a valid application property. The property is valid if it is not one of the reserved properties, only uses US-ASCII printable chars, and does not contain: ()<>@,;:\"/[]?={} (space) (horizontal tab).

Parameters:

name - the property name.

value - the property value.

Returns:

whether the property is a valid application property.

usesValidChars

protected static boolean usesValidChars(String s)

Returns true if the string only uses US-ASCII printable chars and does not contain: ()<>@,;:\"/[]?={} (space) (horizontal tab)

Parameters:

s - the string.

Returns:

whether the string only uses US-ASCII printable chars and does not contain: ()<>@,;:\"/[]?={} (space) (horizontal tab)