com.microsoft.azure.sdk.iot.deps.serializer

Class ParserUtility

java.lang.Object

com.microsoft.azure.sdk.iot.deps.serializer.ParserUtility

public class ParserUtility
extends 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 String	dateTimeUtcToString(Date date) Helper to convert the provided Date UTC into String.
static String	getDateStringFromDate(Date date) Convert from a date object back into a string representation Expected format of returned string: "2016-01-21T11:05:21"
static Date	getDateTimeUtc(String dataTime) Helper to convert the provided string in a UTC Date.
static List<Object>	getJsonArrayValue(com.google.gson.JsonArray jsonArray)
static Map<String,Object>	getJsonObjectValue(com.google.gson.JsonObject jsonObject)
static Object	getJsonPrimitiveValue(com.google.gson.JsonPrimitive jsonPrimitive)
static com.google.gson.JsonElement	mapToJsonElement(Map<String,Object> map) Helper to convert a provided map in to a JsonElement, including sub-maps.
static Object	resolveJsonElement(com.google.gson.JsonElement jsonElement)
static Date	stringToDateTimeOffset(String dateTime) Helper to convert the provided string in a offset Date.
static void	validateBlobName(String blobName) Helper to validate if the provided blob name is not null, empty, and valid.
static void	validateHostName(String hostName) Validate if a provided host name is valid using the follow criteria.
static void	validateId(String id) Validate if a provided ID is valid using the follow criteria.
static void	validateKey(String key, boolean isMetadata) Helper to validate if the provided string is a valid json key.
static void	validateMap(Map<String,Object> map, int maxLevel, boolean allowMetadata) Helper to validate if the provided map in terms of maximum levels and optionally if the keys ar not metadata.
static void	validateObject(Object val) Helper to validate if the provided object is not null.
static void	validateQuery(String query) Validates if query contains select and from keywords and also if it is a valid utf-8 string
static void	validateStringUTF8(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(String str)
                               throws 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:

IllegalArgumentException - if the string do not fit the criteria.

validateQuery

public static void validateQuery(String query)
                          throws 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:

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

validateBlobName

public static void validateBlobName(String blobName)
                             throws 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:

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

validateObject

public static void validateObject(Object val)
                           throws IllegalArgumentException

Helper to validate if the provided object is not null.

Parameters:

val - is the object to be validated.

Throws:

IllegalArgumentException - if the object do not fit the criteria.

validateKey

public static void validateKey(String key,
                               boolean isMetadata)
                        throws IllegalArgumentException

Helper to validate if the provided string is a valid json key.

Parameters:

key - is the string to be validated.

isMetadata - defines if the key belongs to a metadata, which allows character `$`.

Throws:

IllegalArgumentException - if the string do not fit the criteria.

validateMap

public static void validateMap(Map<String,Object> map,
                               int maxLevel,
                               boolean allowMetadata)
                        throws 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.

maxLevel - the max number of level allowed in the map.

allowMetadata - the boolean that indicates if the key can contain metadata `$` or not.

Throws:

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

validateId

public static void validateId(String id)
                       throws IllegalArgumentException

Validate if a provided ID is valid using the follow criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

Parameters:

id - is the ID to test

Throws:

IllegalArgumentException - if the ID do not fits the criteria

validateHostName

public static void validateHostName(String hostName)
                             throws IllegalArgumentException

Validate if a provided host name is valid using the follow criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. Contains at least one separator '.'

Parameters:

hostName - is the host name to test

Throws:

IllegalArgumentException - if the provided host name do not fits the criteria

getDateTimeUtc

public static Date getDateTimeUtc(String dataTime)
                           throws 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:

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

stringToDateTimeOffset

public static Date stringToDateTimeOffset(String dateTime)
                                   throws 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:

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

dateTimeUtcToString

public static String dateTimeUtcToString(Date date)
                                  throws 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:

IllegalArgumentException - if the provided date is null.

getDateStringFromDate

public static String getDateStringFromDate(Date date)
                                    throws 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:

IllegalArgumentException - if the provided date is null

mapToJsonElement

public static com.google.gson.JsonElement mapToJsonElement(Map<String,Object> map)
                                                    throws 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:

IllegalArgumentException - if the provided map is null.

resolveJsonElement

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

getJsonPrimitiveValue

public static Object getJsonPrimitiveValue(com.google.gson.JsonPrimitive jsonPrimitive)

getJsonObjectValue

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

getJsonArrayValue

public static List<Object> getJsonArrayValue(com.google.gson.JsonArray jsonArray)