TwinParser (Dependencies for Iot Hub Java SDK 0.8.3 API)

java.lang.Object
- com.microsoft.azure.sdk.iot.deps.serializer.TwinParser

Deprecated.
As of release 0.4.0, replaced by TwinState
```
@Deprecated
public class TwinParser
extends Object
```
TwinParser Representation including the twin collection and Json serializer and deserializer.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RegisterManagerParser`	`manager` Deprecated.
`protected TwinProperties`	`properties` Deprecated.
`protected TwinTags`	`tags` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`TwinParser()` Deprecated. CONSTRUCTOR Create a TwinParser instance with default values.
`TwinParser(TwinChangedCallback onDesiredCallback)` Deprecated. CONSTRUCTOR Create a TwinParser instance with default values.
`TwinParser(TwinChangedCallback onDesiredCallback, TwinChangedCallback onReportedCallback)` Deprecated. CONSTRUCTOR Create a TwinParser instance with default values.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`enableMetadata()` Deprecated. Enable metadata report in the Json.
`void`	`enableTags()` Deprecated. Enable tags in the Twin collection and in the Json.
`TwinConnectionState`	`getConnectionState()` Deprecated. Getter for connection state
`String`	`getConnectionStateUpdatedTime()` Deprecated. Getter for connection state updated date and time
`Map<String,Object>`	`getDesiredPropertyMap()` Deprecated. Return a map with all `desired` properties in the collection.
`Integer`	`getDesiredPropertyVersion()` Deprecated. Return the `desired` property version.
`String`	`getDeviceId()` Deprecated. Getter for device name
`String`	`getETag()` Deprecated. Getter for ETag
`String`	`getGenerationId()` Deprecated. Getter for device generation name
`String`	`getLastActivityTime()` Deprecated. Getter for last activity time
`Map<String,Object>`	`getReportedPropertyMap()` Deprecated. Return a map with all `reported` properties in the collection.
`Integer`	`getReportedPropertyVersion()` Deprecated. Return the `reported` property version.
`TwinStatus`	`getStatus()` Deprecated. Getter for device status
`String`	`getStatusReason()` Deprecated. Getter for status reason
`String`	`getStatusUpdatedTime()` Deprecated. Getter for status updated date and time
`Map<String,Object>`	`getTagsMap()` Deprecated. Return a map with all `tags` in the collection.
`Integer`	`getVersion()` Deprecated. Getter for Twin version
`String`	`resetDesiredProperty(Map<String,Object> propertyMap)` Deprecated. Reset the `desired` properties information in the collection, deleting all old properties and add all the new provided ones.
`String`	`resetReportedProperty(Map<String,Object> propertyMap)` Deprecated. Reset the `reported` properties information in the collection, deleting all old properties and add all the new provided ones.
`String`	`resetTags(Map<String,Object> tagsMap)` Deprecated. Reset the `tags` information in the collection, deleting all old tags and add all the new provided ones.
`void`	`setDesiredCallback(TwinChangedCallback onDesiredCallback)` Deprecated. Set the callback function to report changes on the `Desired` collection when `TwinParser` receives a new json.
`void`	`setDeviceId(String deviceId)` Deprecated. Setter for device name
`void`	`setETag(String eTag)` Deprecated. Setter for ETag.
`void`	`setReportedCallback(TwinChangedCallback onReportedCallback)` Deprecated. Set the callback function to report changes on the `Reported` collection when `TwinParser` receives a new json.
`void`	`setTagsCallback(TwinChangedCallback onTagsCallback)` Deprecated. Set the callback function to report changes on the `tags` collection when `TwinParser` receives a new json.
`String`	`toJson()` Deprecated. Create a String with a json content that represents all the information in the TwinParser class and innerClasses.
`com.google.gson.JsonElement`	`toJsonElement()` Deprecated. Create a JsonElement that represents all the information in the TwinParser class and innerClasses.
`String`	`updateDesiredProperty(Map<String,Object> propertyMap)` Deprecated. Update the `desired` properties information in the collection, and return a string with a json that contains a sub-collection of added properties, or properties with new value.
`void`	`updateDesiredProperty(String json)` Deprecated. Update the `desired` properties information in the collection, using the information parsed from the provided json.
`String`	`updateDeviceManager(String deviceId, TwinStatus status, String statusReason)` Deprecated. Update the device manager information in the collection, and return a string with a json that contains a the new device manager description, including new and old values.
`String`	`updateReportedProperty(Map<String,Object> propertyMap)` Deprecated. Update the `reported` properties information in the collection, and return a string with a json that contains a sub-collection of added properties, or properties with new value.
`void`	`updateReportedProperty(String json)` Deprecated. Update the `reported` properties information in the collection, using the information parsed from the provided json.
`String`	`updateTags(Map<String,Object> tagsMap)` Deprecated. Update the `tags` information in the collection, and return a string with a json that contains a sub-collection of added tags, or tags with new value.
`String`	`updateTwin(Map<String,Object> desiredPropertyMap, Map<String,Object> reportedPropertyMap, Map<String,Object> tagsMap)` Deprecated. Update properties and tags information in the collection, and return a string with a json that contains a sub-collection of added properties, properties with new value, added tags, and tags with new values.
`void`	`updateTwin(String json)` Deprecated. Update the properties information in the collection, using the information parsed from the provided json.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tags
```
protected TwinTags tags
```
    Deprecated.
  - properties
```
protected TwinProperties properties
```
    Deprecated.
  - manager
```
protected RegisterManagerParser manager
```
    Deprecated.
- Constructor Detail
  - TwinParser
```
public TwinParser()
```
    Deprecated.
    
    CONSTRUCTOR Create a TwinParser instance with default values. set OnDesiredCallback as null set OnReportedCallback as null set Tags as null
  - TwinParser
```
public TwinParser(TwinChangedCallback onDesiredCallback)
```
    Deprecated.
    
    CONSTRUCTOR Create a TwinParser instance with default values. set OnReportedCallback as null set Tags as null
    
    Parameters:
    
    onDesiredCallback - - Callback function to report changes on the `Desired` collection.
  - TwinParser
```
public TwinParser(TwinChangedCallback onDesiredCallback,
                  TwinChangedCallback onReportedCallback)
```
    Deprecated.
    
    CONSTRUCTOR Create a TwinParser instance with default values. set Tags as null
    
    Parameters:
    
    onDesiredCallback - - Callback function to report changes on the `Desired` collection.
    
    onReportedCallback - - Callback function to report changes on the `Reported` collection.
- Method Detail
  - setDesiredCallback
```
public void setDesiredCallback(TwinChangedCallback onDesiredCallback)
```
    Deprecated.
    
    Set the callback function to report changes on the `Desired` collection when `TwinParser` receives a new json.
    
    Parameters:
    
    onDesiredCallback - - Callback function to report changes on the `Desired` collection.
  - setReportedCallback
```
public void setReportedCallback(TwinChangedCallback onReportedCallback)
```
    Deprecated.
    
    Set the callback function to report changes on the `Reported` collection when `TwinParser` receives a new json.
    
    Parameters:
    
    onReportedCallback - - Callback function to report changes on the `Reported` collection.
  - setTagsCallback
```
public void setTagsCallback(TwinChangedCallback onTagsCallback)
```
    Deprecated.
    
    Set the callback function to report changes on the `tags` collection when `TwinParser` receives a new json.
    
    Parameters:
    
    onTagsCallback - - Callback function to report changes on the `Reported` collection.
  - toJson
```
public String toJson()
```
    Deprecated.
    
    Create a String with a json content that represents all the information in the TwinParser class and innerClasses.
    
    Returns:
    
    String with the json content.
  - toJsonElement
```
public com.google.gson.JsonElement toJsonElement()
```
    Deprecated.
    
    Create a JsonElement that represents all the information in the TwinParser class and innerClasses.
    
    Returns:
    
    JsonElement with the Twin information.
  - enableTags
```
public void enableTags()
```
    Deprecated.
    
    Enable tags in the Twin collection and in the Json.
  - enableMetadata
```
public void enableMetadata()
```
    Deprecated.
    
    Enable metadata report in the Json.
  - updateTwin
```
public String updateTwin(Map<String,Object> desiredPropertyMap,
                         Map<String,Object> reportedPropertyMap,
                         Map<String,Object> tagsMap)
                  throws IllegalArgumentException,
                         IOException
```
    Deprecated.
    
    Update properties and tags information in the collection, and return a string with a json that contains a sub-collection of added properties, properties with new value, added tags, and tags with new values.
    
    Parameters:
    
    desiredPropertyMap - - Map of `desired` property to change the collection.
    
    reportedPropertyMap - - Map of `reported` property to change the collection.
    
    tagsMap - - Map of `tags` to change the collection.
    
    Returns:
    
    Json with added or changed properties and tags
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the properties or tags in the maps do not fits the requirements.
    
    IOException - This exception is thrown if tags the is not enabled.
  - updateDesiredProperty
```
public String updateDesiredProperty(Map<String,Object> propertyMap)
                             throws IllegalArgumentException
```
    Deprecated.
    
    Update the `desired` properties information in the collection, and return a string with a json that contains a sub-collection of added properties, or properties with new value.
    
    Parameters:
    
    propertyMap - - Map of `desired` property to change the collection.
    
    Returns:
    
    Json with added or changed properties
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the properties in the map do not fits the requirements.
  - updateReportedProperty
```
public String updateReportedProperty(Map<String,Object> propertyMap)
                              throws IllegalArgumentException
```
    Deprecated.
    
    Update the `reported` properties information in the collection, and return a string with a json that contains a sub-collection of added properties, or properties with new value.
    
    Parameters:
    
    propertyMap - - Map of `reported` property to change the collection.
    
    Returns:
    
    Json with added or changed properties
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the properties in the map do not fits the requirements.
  - updateTags
```
public String updateTags(Map<String,Object> tagsMap)
                  throws IllegalArgumentException,
                         IOException
```
    Deprecated.
    
    Update the `tags` information in the collection, and return a string with a json that contains a sub-collection of added tags, or tags with new value.
    
    Parameters:
    
    tagsMap - - Map of `tags` to change the collection.
    
    Returns:
    
    Json with added or changed tags
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the tags in the map do not fits the requirements.
    
    IOException - This exception is thrown if tags the is not enabled.
  - resetDesiredProperty
```
public String resetDesiredProperty(Map<String,Object> propertyMap)
                            throws IllegalArgumentException
```
    Deprecated.
    
    Reset the `desired` properties information in the collection, deleting all old properties and add all the new provided ones. Return a string with a json that contains a sub-collection of added properties.
    
    Parameters:
    
    propertyMap - - Map of `desired` property to change the collection.
    
    Returns:
    
    Json with added properties
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the properties in the map do not fits the requirements.
  - resetReportedProperty
```
public String resetReportedProperty(Map<String,Object> propertyMap)
                             throws IllegalArgumentException
```
    Deprecated.
    
    Reset the `reported` properties information in the collection, deleting all old properties and add all the new provided ones. Return a string with a json that contains a sub-collection of added properties.
    
    Parameters:
    
    propertyMap - - Map of `reported` property to change the collection.
    
    Returns:
    
    Json with added properties
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the properties in the map do not fits the requirements.
  - resetTags
```
public String resetTags(Map<String,Object> tagsMap)
                 throws IllegalArgumentException,
                        IOException
```
    Deprecated.
    
    Reset the `tags` information in the collection, deleting all old tags and add all the new provided ones. Return a string with a json that contains a sub-collection of added tags.
    
    Parameters:
    
    tagsMap - - Map of `tags` to change the collection.
    
    Returns:
    
    Json with added tags
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the tags in the map do not fits the requirements.
    
    IOException - This exception is thrown if tags the is not enabled.
  - updateTwin
```
public void updateTwin(String json)
                throws IllegalArgumentException
```
    Deprecated.
    
    Update the properties information in the collection, using the information parsed from the provided json. It will fire a callback if any property was added, excluded, or had its value updated.
    
    Parameters:
    
    json - - Json with property to change the collection.
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the Json is not well formed.
  - updateDesiredProperty
```
public void updateDesiredProperty(String json)
                           throws IllegalArgumentException
```
    Deprecated.
    
    Update the `desired` properties information in the collection, using the information parsed from the provided json. It will fire a callback if any property was added, excluded, or had its value updated.
    
    Parameters:
    
    json - - Json with `desired` property to change the collection.
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the Json is not well formed.
  - updateReportedProperty
```
public void updateReportedProperty(String json)
                            throws IllegalArgumentException
```
    Deprecated.
    
    Update the `reported` properties information in the collection, using the information parsed from the provided json. It will fire a callback if any property was added, excluded, or had its value updated.
    
    Parameters:
    
    json - - Json with `reported` property to change the collection.
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if the Json is not well formed.
  - updateDeviceManager
```
public String updateDeviceManager(String deviceId,
                                  TwinStatus status,
                                  String statusReason)
                           throws IllegalArgumentException
```
    Deprecated.
    
    Update the device manager information in the collection, and return a string with a json that contains a the new device manager description, including new and old values.
    
    Parameters:
    
    deviceId - - Device name
    
    status - - Device status("enabled", "disabled")
    
    statusReason - - A 128 char long string storing the reason of suspension (for status="disabled").
    
    Returns:
    
    Json with the manager description. Null if nothing change.
    
    Throws:
    
    IllegalArgumentException - This exception is thrown if there are any inconsistent in the provided description.
  - getDesiredPropertyVersion
```
public Integer getDesiredPropertyVersion()
```
    Deprecated.
    
    Return the `desired` property version.
    
    Returns:
    
    Integer that contains the `desired` property version (it can be null).
  - getReportedPropertyVersion
```
public Integer getReportedPropertyVersion()
```
    Deprecated.
    
    Return the `reported` property version.
    
    Returns:
    
    Integer that contains the `reported` property version (it can be null).
  - getDesiredPropertyMap
```
public Map<String,Object> getDesiredPropertyMap()
```
    Deprecated.
    
    Return a map with all `desired` properties in the collection.
    
    Returns:
    
    A map with all `desired` properties in the collection (it can be null).
  - getReportedPropertyMap
```
public Map<String,Object> getReportedPropertyMap()
```
    Deprecated.
    
    Return a map with all `reported` properties in the collection.
    
    Returns:
    
    A map with all `reported` properties in the collection (it can be null).
  - getTagsMap
```
public Map<String,Object> getTagsMap()
                              throws IOException
```
    Deprecated.
    
    Return a map with all `tags` in the collection.
    
    Returns:
    
    A map with all `tags` in the collection (it can be null).
    
    Throws:
    
    IOException - This exception is thrown if tags the is not enabled.
  - getDeviceId
```
public String getDeviceId()
```
    Deprecated.
    
    Getter for device name
    
    Returns:
    
    Device name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
  - setDeviceId
```
public void setDeviceId(String deviceId)
                 throws IllegalArgumentException
```
    Deprecated.
    
    Setter for device name
    
    Parameters:
    
    deviceId - device id A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}
    
    Throws:
    
    IllegalArgumentException - if the provided device Id is not valid.
  - getGenerationId
```
public String getGenerationId()
```
    Deprecated.
    
    Getter for device generation name
    
    Returns:
    
    Device generation Id
  - getETag
```
public String getETag()
```
    Deprecated.
    
    Getter for ETag
    
    Returns:
    
    A string representing a weak ETAG version of this JSON description. This is a hash.
  - getVersion
```
public Integer getVersion()
```
    Deprecated.
    
    Getter for Twin version
    
    Returns:
    
    A Integer representing a twin tags and properties version in the JSON. It can be null
  - setETag
```
public void setETag(String eTag)
             throws IllegalArgumentException
```
    Deprecated.
    
    Setter for ETag.
    
    Parameters:
    
    eTag - is a string representing a weak ETAG version of this JSON description. This is a hash.
    
    Throws:
    
    IllegalArgumentException - if the provided eTag Id is not valid.
  - getStatus
```
public TwinStatus getStatus()
```
    Deprecated.
    
    Getter for device status
    
    Returns:
    
    "enabled", "disabled". If "enabled", this device is authorized to connect. If "disabled" this device cannot receive or send messages, and statusReason must be set.
  - getStatusReason
```
public String getStatusReason()
```
    Deprecated.
    
    Getter for status reason
    
    Returns:
    
    A 128 char long string storing the reason of suspension. (all UTF-8 chars allowed).
  - getStatusUpdatedTime
```
public String getStatusUpdatedTime()
```
    Deprecated.
    
    Getter for status updated date and time
    
    Returns:
    
    Datetime of last time the state was updated.
  - getConnectionState
```
public TwinConnectionState getConnectionState()
```
    Deprecated.
    
    Getter for connection state
    
    Returns:
    
    The connectionState string
  - getConnectionStateUpdatedTime
```
public String getConnectionStateUpdatedTime()
```
    Deprecated.
    
    Getter for connection state updated date and time
    
    Returns:
    
    The string containing the time when the connectionState parameter was updated
  - getLastActivityTime
```
public String getLastActivityTime()
```
    Deprecated.
    
    Getter for last activity time
    
    Returns:
    
    The string containing the time when the lastActivity parameter was updated

Class TwinParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tags

properties

manager

Constructor Detail

TwinParser

TwinParser

TwinParser

Method Detail

setDesiredCallback

setReportedCallback

setTagsCallback

toJson

toJsonElement

enableTags

enableMetadata

updateTwin

updateDesiredProperty

updateReportedProperty

updateTags

resetDesiredProperty

resetReportedProperty

resetTags

updateTwin

updateDesiredProperty

updateReportedProperty

updateDeviceManager

getDesiredPropertyVersion

getReportedPropertyVersion

getDesiredPropertyMap

getReportedPropertyMap

getTagsMap

getDeviceId

setDeviceId

getGenerationId

getETag

getVersion

setETag

getStatus

getStatusReason

getStatusUpdatedTime

getConnectionState

getConnectionStateUpdatedTime

getLastActivityTime