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

Class ParserUtility

java.lang.Object

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

public class ParserUtility
extends java.lang.Object

Set of static functions to help the serializer.

Constructor Summary

Constructors

Constructor and Description
ParserUtility()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	dateTimeUtcToString(java.util.Date date) Helper to convert the provided Date UTC into String.
static java.util.Date	getDateTimeUtc(java.lang.String dataTime) Helper to convert the provided string in a UTC Date.
static java.util.Map<java.lang.String,java.lang.Object>	getJsonObjectValue(com.google.gson.JsonObject jsonObject)
static java.lang.String	getUTCDateStringFromDate(java.util.Date date) Convert from a date object back into a string representation Expected format of returned string: "2016-01-21T11:05:21"
static com.google.gson.JsonElement	mapToJsonElement(java.util.Map<java.lang.String,java.lang.Object> map) Helper to convert a provided map in to a JsonElement, including sub-maps.
static java.lang.Object	resolveJsonElement(com.google.gson.JsonElement jsonElement)
static java.util.Date	stringToDateTimeOffset(java.lang.String dateTime) Helper to convert the provided string in a offset Date.
static void	validateBlobName(java.lang.String blobName) Helper to validate if the provided blob name is not null, empty, and valid.
static void	validateMap(java.util.Map<java.lang.String,java.lang.Object> map) Helper to validate if the provided map in terms of maximum levels and optionally if the keys ar not metadata.
static void	validateObject(java.lang.Object val) Helper to validate if the provided object is not null.
static void	validateQuery(java.lang.String query) Validates if query contains select and from keywords and also if it is a valid utf-8 string
static void	validateStringUTF8(java.lang.String str) Helper to validate if the provided string is not null, empty, and all characters are UTF-8.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParserUtility

public ParserUtility()

Method Detail

validateStringUTF8

public static void validateStringUTF8(java.lang.String str)
                               throws java.lang.IllegalArgumentException

Helper to validate if the provided string is not null, empty, and all characters are UTF-8.

Parameters:

str - is the string to be validated.

Throws:

java.lang.IllegalArgumentException - if the string do not fit the criteria.

validateQuery

public static void validateQuery(java.lang.String query)
                          throws java.lang.IllegalArgumentException

Validates if query contains select and from keywords and also if it is a valid utf-8 string

Parameters:

query - query to be validated

Throws:

java.lang.IllegalArgumentException - if query does not contain "select" or "from" or is not a valid utf-8 string

validateBlobName

public static void validateBlobName(java.lang.String blobName)
                             throws java.lang.IllegalArgumentException

Helper to validate if the provided blob name is not null, empty, and valid.

Parameters:

blobName - is the blob name to be validated.

Throws:

java.lang.IllegalArgumentException - if the blob name do not fit the criteria.

validateObject

public static void validateObject(java.lang.Object val)
                           throws java.lang.IllegalArgumentException

Helper to validate if the provided object is not null.

Parameters:

val - is the object to be validated.

Throws:

java.lang.IllegalArgumentException - if the object do not fit the criteria.

validateMap

public static void validateMap(java.util.Map<java.lang.String,java.lang.Object> map)
                        throws java.lang.IllegalArgumentException

Helper to validate if the provided map in terms of maximum levels and optionally if the keys ar not metadata.

Parameters:

map - the Map to be validate. It can be null, and it will succeed in this case.

Throws:

java.lang.IllegalArgumentException - If the Map contains more than maxLevel levels or do not allow metadata but contains metadata key.

getDateTimeUtc

public static java.util.Date getDateTimeUtc(java.lang.String dataTime)
                                     throws java.lang.IllegalArgumentException

Helper to convert the provided string in a UTC Date. Expected format: "2016-06-01T21:22:43.7996883Z"

Parameters:

dataTime - is the string with the date and time

Returns:

Date parsed from the string

Throws:

java.lang.IllegalArgumentException - if the date and time in the string is not in the correct format.

stringToDateTimeOffset

public static java.util.Date stringToDateTimeOffset(java.lang.String dateTime)
                                             throws java.lang.IllegalArgumentException

Helper to convert the provided string in a offset Date. Expected format: "2016-06-01T21:22:41+00:00"

Parameters:

dateTime - is the string with the date and time

Returns:

Date parsed from the string

Throws:

java.lang.IllegalArgumentException - if the date and time in the string is not in the correct format.

dateTimeUtcToString

public static java.lang.String dateTimeUtcToString(java.util.Date date)
                                            throws java.lang.IllegalArgumentException

Helper to convert the provided Date UTC into String. Expected result: "2016-06-01T21:22:43.799Z"

Parameters:

date - is the Date with the date and time

Returns:

the String with the date and time using the UTC format.

Throws:

java.lang.IllegalArgumentException - if the provided date is null.

getUTCDateStringFromDate

public static java.lang.String getUTCDateStringFromDate(java.util.Date date)
                                                 throws java.lang.IllegalArgumentException

Convert from a date object back into a string representation Expected format of returned string: "2016-01-21T11:05:21"

Parameters:

date - the date to convert into a string

Returns:

the date represented as a string

Throws:

java.lang.IllegalArgumentException - if the provided date is null

mapToJsonElement

public static com.google.gson.JsonElement mapToJsonElement(java.util.Map<java.lang.String,java.lang.Object> map)
                                                    throws java.lang.IllegalArgumentException

Helper to convert a provided map in to a JsonElement, including sub-maps.

Parameters:

map - is the map to serialize

Returns:

a JsonElement that represents the content of the map.

Throws:

java.lang.IllegalArgumentException - if the provided map is null.

resolveJsonElement

public static java.lang.Object resolveJsonElement(com.google.gson.JsonElement jsonElement)

getJsonObjectValue

public static java.util.Map<java.lang.String,java.lang.Object> getJsonObjectValue(com.google.gson.JsonObject jsonObject)