com.geotab.model.serialization

Class ApiJsonSerializer

java.lang.Object

com.geotab.model.serialization.ApiJsonSerializer

public final class ApiJsonSerializer
extends Object

Json serializer singleton which configures and keeps a single reference of the ObjectMapper to be used by the GeotabApi.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.ObjectMapper	buildDefaultObjectMapper() Build default configuration for ObjectMapper.
static ApiJsonSerializer	getInstance()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Get the configured ObjectMapper.
void	withCustomObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) !!! Use with caution !!!

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ApiJsonSerializer getInstance()

buildDefaultObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper buildDefaultObjectMapper()

Build default configuration for ObjectMapper.

Returns:

The ObjectMapper.

withCustomObjectMapper

public void withCustomObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

!!! Use with caution !!!

This method represents an extension point for the json serialization. It's recommended that the API uses the default serialization config, but in case custom serialization config is needed, then this method can be used.

Recommendation is to start from buildDefaultObjectMapper(), add custom config and then call this method before instantiating GeotabApi.

Parameters:

objectMapper - The custom ObjectMapper.

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Get the configured ObjectMapper.

Returns:

The ObjectMapper.