com.microsoft.azure.sdk.iot.device.twin

Class MethodParser

java.lang.Object

com.microsoft.azure.sdk.iot.device.twin.MethodParser

public class MethodParser
extends java.lang.Object

Representation of a single Direct Method Access collection with a Json serializer and deserializer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MethodParser.Operation

Constructor Summary

Constructors

Constructor and Description
MethodParser() CONSTRUCTOR Create a MethodParser instance with provided values.
MethodParser(com.google.gson.JsonElement payload) CONSTRUCTOR Create a MethodParser instance with provided values.
MethodParser(java.lang.String name, java.lang.Long responseTimeout, java.lang.Long connectTimeout, com.google.gson.JsonElement payload) CONSTRUCTOR Create a MethodParser instance with provided values.

Method Summary

Modifier and Type	Method and Description
void	fromJson(java.lang.String json) Set the Method collection with the provided information in the json.
com.google.gson.JsonElement	getPayload() Return an Object with the payload.
com.google.gson.JsonElement	getPayloadFromJson(java.lang.String json)
java.lang.String	toJson() Create a String with a json content that represents all the information in the method collection.
com.google.gson.JsonElement	toJsonElement() Create a JsonElement with a content that represents all the information in the method collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodParser

public MethodParser()

CONSTRUCTOR Create a MethodParser instance with provided values.

MethodParser

public MethodParser(java.lang.String name,
                    java.lang.Long responseTimeout,
                    java.lang.Long connectTimeout,
                    com.google.gson.JsonElement payload)
             throws java.lang.IllegalArgumentException

CONSTRUCTOR Create a MethodParser instance with provided values.

Parameters:

name - - method name [required].

responseTimeout - - maximum interval of time, in seconds, that the Direct Method will wait for answer. It can be null.

connectTimeout - - maximum interval of time, in seconds, that the Direct Method will wait for the connection. It can be null.

payload - - Object that contains the payload defined by the user. It can be null.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the one of the provided information do not fits the requirements.

MethodParser

public MethodParser(com.google.gson.JsonElement payload)

CONSTRUCTOR Create a MethodParser instance with provided values.

Parameters:

payload - - Object that contains the payload defined by the user. It can be null.

Method Detail

fromJson

public void fromJson(java.lang.String json)
              throws java.lang.IllegalArgumentException

Set the Method collection with the provided information in the json.

Parameters:

json - - Json with the information to change the collection. - If contains `methodName`, it is a full method including `methodName`, `responseTimeoutInSeconds`, `connectTimeoutInSeconds`, and `payload`. - If contains `status`, it is a response with `status` and `payload`. - Otherwise, it is only `payload`.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the one of the provided information do not fits the requirements.

getPayloadFromJson

public com.google.gson.JsonElement getPayloadFromJson(java.lang.String json)

getPayload

public com.google.gson.JsonElement getPayload()

Return an Object with the payload.

Returns:

An Object with the payload. It can be null.

toJson

public java.lang.String toJson()
                        throws java.lang.IllegalArgumentException

Create a String with a json content that represents all the information in the method collection.

Returns:

String with the json content.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the one of the provided information do not fits the requirements.

toJsonElement

public com.google.gson.JsonElement toJsonElement()
                                          throws java.lang.IllegalArgumentException

Create a JsonElement with a content that represents all the information in the method collection.

Returns:

JsonElement with the content.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the one of the provided information do not fits the requirements.