com.cinchapi.concourse.util

Class TypeAdapters

Object

TypeAdapters

public class TypeAdapters
extends Object

A collection of TypeAdapter factories to use when converting java objects to their appropriate JSON representation.

Constructor Summary

Constructors

Constructor and Description
TypeAdapters()

Method Summary

Modifier and Type	Method and Description
static TypeAdapterFactory	collectionFactory() Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for Collections.
static TypeAdapterFactory	collectionFactory(boolean nullSafe) Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for Collections.
static TypeAdapter<Collection<?>>	forCollection() Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.
static TypeAdapter<Object>	forGenericObject() Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.
static TypeAdapter<Map<?,?>>	forMap() Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.
static TypeAdapter<TObject>	forTObject() Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.
static TypeAdapterFactory	primitiveTypesFactory() Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for primitive Concourse types.
static TypeAdapterFactory	primitiveTypesFactory(boolean nullSafe) Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for primitive Concourse types.
static TypeAdapterFactory	tObjectFactory() Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for TObjects.
static TypeAdapterFactory	tObjectFactory(boolean nullSafe) Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for TObjects.

Methods inherited from class Object

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

Constructor Detail

TypeAdapters

public TypeAdapters()

Method Detail

collectionFactory

public static TypeAdapterFactory collectionFactory()

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for Collections.

Returns:

the type adapter factory

collectionFactory

public static TypeAdapterFactory collectionFactory(boolean nullSafe)

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for Collections.

Parameters:

nullSafe -

Returns:

the type adapter factory

forCollection

@Deprecated
public static TypeAdapter<Collection<?>> forCollection()

Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.

Return the TypeAdapter that checks the size of a collection and only converts them to a JSON array if necessary (i.e. a single item collection will be converted to a single object in JSON).

Returns:

the TypeAdapter to use for conversions

forGenericObject

@Deprecated
public static TypeAdapter<Object> forGenericObject()

Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.

Return the TypeAdapter that converts generic objects to the correct JSON representation so they can be converted back to java if necessary.

Returns:

the TypeAdapter to use for conversions

forMap

@Deprecated
public static TypeAdapter<Map<?,?>> forMap()

Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.

Return the TypeAdapter that converts built-in maps to the correct JSON representation by deferring to the java type adapter when serializing values. This enables Concourse Server to correct convert the resultant JSON string back to a Java structure when necessary.

Returns:

the TypeAdapter to use for conversions

forTObject

@Deprecated
public static TypeAdapter<TObject> forTObject()

Deprecated. The use of the type adapter is flawed because it doesn't leverage Gson's ability to dynamically override adapters from different sources. The preferred approach is to pass primitiveTypesFactory() to GsonBuilder.registerTypeAdapterFactory(TypeAdapterFactory) instead.

Return the TypeAdapter that converts TObjects to the correct JSON representation so they can be converted back to java if necessary.

Returns:

the TypeAdapter to use for conversions

primitiveTypesFactory

public static TypeAdapterFactory primitiveTypesFactory()

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for primitive Concourse types.

Returns:

the type adapter factory

primitiveTypesFactory

public static TypeAdapterFactory primitiveTypesFactory(boolean nullSafe)

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for primitive Concourse types.

Parameters:

nullSafe -

Returns:

the type adapter factory

tObjectFactory

public static TypeAdapterFactory tObjectFactory()

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for TObjects.

Returns:

the type adapter factory

tObjectFactory

public static TypeAdapterFactory tObjectFactory(boolean nullSafe)

Return a TypeAdapterFactory that contains the preferred JSON de/serialization rules for TObjects.

Parameters:

nullSafe -

Returns:

the type adapter factory