APIHelper (ClickSend 3.1.1 API)

java.lang.Object
- com.clicksend.APIHelper

```
public class APIHelper
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static com.fasterxml.jackson.databind.ObjectMapper mapper

Fields
Modifier and Type	Field and Description
`static com.fasterxml.jackson.databind.ObjectMapper`	`mapper`

Constructor Summary

Constructors
Constructor and Description

APIHelper()

Constructors
Constructor and Description
`APIHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendUrlWithQueryParameters(StringBuilder queryBuilder, Map<String,Object> parameters)` Appends the given set of parameters to the given query string
`static void`	`appendUrlWithTemplateParameters(StringBuilder queryBuilder, Map<String,Object> parameters)` Replaces template parameters in the given url
`static String`	`cleanUrl(StringBuilder url)` Validates and processes the given Url
`static String`	`dateToString(Date date)` Convert a date to an ISO8601 formatted string
`static LinkedHashMap<String,Object>`	`deserialize(String json)` JSON Deserialization of the given json string.
`static <T> T`	`deserialize(String json, Class<T> typeReference)` JSON Deserialization of the given json string.
`static <T> T`	`deserialize(String json, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)` JSON Deserialization of the given json string.
`static ExecutorService`	`getScheduler()` Singleton access to the threadpool scheduler
`static boolean`	`isNullOrWhiteSpace(String s)` Validates if the string is null, empty or whitespace
`static Date`	`parseDate(String date)` Parse a date from its string representation
`static void`	`populate(String json, APIException obj)` Populates an object of an APIException subclass with the required properties.
`static Map<String,Object>`	`prepareFormFields(Object value)` Prepares Array style form fields from a given array of values
`static void`	`removeNullValues(Map<String,?> map)` Removes null values from the given map
`static void`	`replaceAll(StringBuilder stringBuilder, String toReplace, String replaceWith)` Replaces all occurrences of the given string in the string builder
`static String`	`serialize(Object obj)` JSON Serialization of a given object.
`static void`	`shutdown()` Shutdown all the threads

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

- Field Detail
  - mapper
```
public static com.fasterxml.jackson.databind.ObjectMapper mapper
```
- Constructor Detail
  - APIHelper
```
public APIHelper()
```
- Method Detail
  - getScheduler
```
public static ExecutorService getScheduler()
```
    Singleton access to the threadpool scheduler
  - shutdown
```
public static void shutdown()
```
    Shutdown all the threads
  - parseDate
```
public static Date parseDate(String date)
```
    Parse a date from its string representation
    
    Parameters:
    
    date - ISO8601 encodede date string
    
    Returns:
    
    Parsed Date object
  - dateToString
```
public static String dateToString(Date date)
```
    Convert a date to an ISO8601 formatted string
    
    Parameters:
    
    date - Date object to format
    
    Returns:
    
    ISO8601 formatted date string
  - serialize
```
public static String serialize(Object obj)
                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    JSON Serialization of a given object.
    
    Parameters:
    
    obj - The object to serialize into JSON
    
    Returns:
    
    The serialized Json string representation of the given object
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - deserialize
```
public static <T> T deserialize(String json,
                                com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
                         throws IOException
```
    JSON Deserialization of the given json string.
    
    Type Parameters:
    
    T - The type of the object to deserialize into
    
    Parameters:
    
    json - The json string to deserialize
    
    Returns:
    
    The deserialized object
    
    Throws:
    
    IOException
  - deserialize
```
public static <T> T deserialize(String json,
                                Class<T> typeReference)
                         throws IOException
```
    JSON Deserialization of the given json string.
    
    Type Parameters:
    
    T - The type of the object to deserialize into
    
    Parameters:
    
    jParser - The json parser for reading json to deserialize
    
    Returns:
    
    The deserialized object
    
    Throws:
    
    IOException
  - populate
```
public static void populate(String json,
                            APIException obj)
                     throws IOException
```
    Populates an object of an APIException subclass with the required properties.
    
    Type Parameters:
    
    APIException - The object to populate.
    
    Parameters:
    
    json - The json string to deserialize
    
    Throws:
    
    IOException
  - deserialize
```
public static LinkedHashMap<String,Object> deserialize(String json)
                                                throws IOException
```
    JSON Deserialization of the given json string.
    
    Parameters:
    
    json - The json string to deserialize
    
    Returns:
    
    The deserialized json as a Map
    
    Throws:
    
    IOException
  - appendUrlWithTemplateParameters
```
public static void appendUrlWithTemplateParameters(StringBuilder queryBuilder,
                                                   Map<String,Object> parameters)
```
    Replaces template parameters in the given url
    
    Parameters:
    
    queryBuilder - The query string builder to replace the template parameters
    
    parameters - The parameters to replace in the url
  - appendUrlWithQueryParameters
```
public static void appendUrlWithQueryParameters(StringBuilder queryBuilder,
                                                Map<String,Object> parameters)
```
    Appends the given set of parameters to the given query string
    
    Parameters:
    
    queryBuilder - The query url string to append the parameters
    
    parameters - The parameters to append
  - isNullOrWhiteSpace
```
public static boolean isNullOrWhiteSpace(String s)
```
    Validates if the string is null, empty or whitespace
    
    Parameters:
    
    s - The string to validate
    
    Returns:
    
    The result of validation
  - replaceAll
```
public static void replaceAll(StringBuilder stringBuilder,
                              String toReplace,
                              String replaceWith)
```
    Replaces all occurrences of the given string in the string builder
    
    Parameters:
    
    stringBuilder - The string builder to update with replaced strings
    
    toReplace - The string to replace in the string builder
    
    replaceWith - The string to replace with
  - removeNullValues
```
public static void removeNullValues(Map<String,?> map)
```
    Removes null values from the given map
  - cleanUrl
```
public static String cleanUrl(StringBuilder url)
```
    Validates and processes the given Url
    
    Parameters:
    
    url - The given Url to process
    
    Returns:
    
    Pre-process Url as string
  - prepareFormFields
```
public static Map<String,Object> prepareFormFields(Object value)
```
    Prepares Array style form fields from a given array of values
    
    Parameters:
    
    value - Value for the form fields
    
    Returns:
    
    Dictionary of form fields created from array elements

Class APIHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mapper

Constructor Detail

APIHelper

Method Detail

getScheduler

shutdown

parseDate

dateToString

serialize

deserialize

deserialize

populate

deserialize

appendUrlWithTemplateParameters

appendUrlWithQueryParameters

isNullOrWhiteSpace

replaceAll

removeNullValues

cleanUrl

prepareFormFields