com.scvngr.levelup.core.model.factory.json

Class GsonModelFactory<T>

java.lang.Object

com.scvngr.levelup.core.model.factory.json.GsonModelFactory<T>

Type Parameters:

T - the type of object to load.

Direct Known Subclasses:

AppConstantsJsonFactory, AppJsonFactory, CampaignMetadataJsonFactory, CampaignRepresentationBasicV1JsonFactory, CarrierAccountJsonFactory, FeedbackJsonFactory, GiftCardOrderJsonFactory, PaymentMethodJsonFactory, PaymentOptionsSummaryJsonFactory, PaymentPreferenceJsonFactory, PermissionsRequestJsonFactory, TicketJsonFactory

@NotThreadSafe
 @LevelUpApi(contract=INTERNAL)
public class GsonModelFactory<T>
extends Object

Loads an LevelUp model from JSON using Gson. When inflating from JSON, this ensures that the model's null annotation contract is enforced. Note: to be null-checked, the model must be in or below the com.scvngr.levelup package. Objects from all other packages will be ignored.

Constructor Summary

Constructors

Constructor and Description
GsonModelFactory(Class<T> type, boolean wrapped) Constructs a new factory.
GsonModelFactory(String typeKey, Class<T> type, boolean wrapped) Constructs a new factory.

Method Summary

Modifier and Type	Method and Description
protected T	createFrom(com.google.gson.JsonObject json) Parse an instance of the model from a JsonObject.
T	from(com.google.gson.JsonObject jsonObject) Parse a model from the JSON object passed, un-nesting from a root element if necessary.
T	from(String json) Parse a model from the JSON object passed, un-nesting from a root element if necessary.
List<T>	fromList(com.google.gson.JsonArray jsonArray) Parse a list of models from the JSON array passed.
List<T>	fromList(String json) Parse a list of models from the JSON array passed.
String	getTypeKey()
protected void	onBuildFactory(com.google.gson.GsonBuilder gsonBuilder) Override this to register type adapters or anything else of that sort.
String	to(T model)
com.google.gson.JsonElement	toJsonElement(T model)
JsonElementRequestBody	toRequestSerializer(T model) Serializes a model instance to a JSON string representation in a RequestBody.

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonModelFactory

public GsonModelFactory(Class<T> type,
                        boolean wrapped)

Constructs a new factory.

Parameters:

type - the type of object to load

wrapped - if true, the input JSON must be wrapped with a JSON object that has a typeKey, as derived from type.

GsonModelFactory

public GsonModelFactory(String typeKey,
                        Class<T> type,
                        boolean wrapped)

Constructs a new factory.

Parameters:

typeKey - the key which the object to parse can be nested under. It will usually be the name of the object's type:

            { "typeKey": { "field1": "test" } }
 

When requesting a single object or a list of objects, the object will be nested under this type key.

type - the type of object to load

wrapped - if true, the input JSON must be wrapped with a JSON object that has a typeKey, as mentioned above.

Method Detail

onBuildFactory

protected void onBuildFactory(com.google.gson.GsonBuilder gsonBuilder)

Override this to register type adapters or anything else of that sort. The default implementation is empty.

Parameters:

gsonBuilder - the Gson builder that will be used for this class.

from

public final T from(com.google.gson.JsonObject jsonObject)

Parse a model from the JSON object passed, un-nesting from a root element if necessary.

Parameters:

jsonObject - the JSON representation of the model to parse.

Returns:

a model instance.

from

public final T from(String json)
             throws com.google.gson.JsonParseException

Parse a model from the JSON object passed, un-nesting from a root element if necessary.

Parameters:

json - the JSON representation of the model to parse.

Returns:

a model instance.

Throws:

com.google.gson.JsonParseException - if there is a problem decoding the JSON structure.

fromList

public final List<T> fromList(com.google.gson.JsonArray jsonArray)
                       throws com.google.gson.JsonParseException

Parse a list of models from the JSON array passed.

Parameters:

jsonArray - the JsonArray containing a list of models.

Returns:

a List of model instances.

Throws:

com.google.gson.JsonParseException - if there is a problem decoding the JSON structure.

fromList

public final List<T> fromList(String json)
                       throws com.google.gson.JsonParseException

Parse a list of models from the JSON array passed.

Parameters:

json - the JSON representation of the list of models to parse.

Returns:

a List of model instances.

Throws:

com.google.gson.JsonParseException - if there is a problem decoding the JSON structure.

to

public final String to(T model)

Parameters:

model - the model to serialize as JSON.

Returns:

a string representation of the given model.

toJsonElement

public final com.google.gson.JsonElement toJsonElement(T model)

Parameters:

model - the model to serialize as JSON.

Returns:

a JsonElement representing the given model.

toRequestSerializer

public final JsonElementRequestBody toRequestSerializer(T model)

Serializes a model instance to a JSON string representation in a RequestBody.

Parameters:

model - the model to serialize as JSON.

Returns:

The JSON representation of the model in a RequestBody.

createFrom

protected T createFrom(com.google.gson.JsonObject json)
                throws com.google.gson.JsonParseException

Parse an instance of the model from a JsonObject.

Parameters:

json - the JSON representation of the model to parse.

Returns:

an instance of T parsed from json.

Throws:

com.google.gson.JsonParseException - If the model fails to parse.

getTypeKey

public final String getTypeKey()

Returns:

the type key which this object can be nested under.