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

Class AbstractJsonModelFactory<T>

java.lang.Object

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

Type Parameters:

T - The type of model this factory produces.

Direct Known Subclasses:

AccessTokenJsonFactory, CampaignJsonFactory, CategoryJsonFactory, CauseAffiliationJsonFactory, ClaimJsonFactory, CreditCardJsonFactory, ErrorJsonFactory, InterstitialJsonFactory, LocationCreditJsonFactory, LocationJsonFactory, LoyaltyJsonFactory, OrderJsonFactory, PaymentTokenJsonFactory, RegistrationJsonFactory, UserJsonFactory, UserWithAccessTokenJsonFactory, WebLinkJsonFactory

@Immutable
 @LevelUpApi(contract=INTERNAL)
public abstract class AbstractJsonModelFactory<T>
extends Object

Superclass for JSON parsers that create model objects using a factory design pattern. Any model object that wishes to be parsed from JSON should have an implementation of this class.

Constructor Summary

Constructors

Constructor and Description
AbstractJsonModelFactory(String typeKey) Constructs a new factory.

Method Summary

Modifier and Type	Method and Description
protected abstract T	createFrom(JSONObject json) Parse an instance of the model from a JSONObject.
T	from(JSONObject jsonObject) Parse a model from the JSON object passed, un-nesting from a root element if necessary.
List<T>	fromList(JSONArray jsonArray) Parse a list of models from the JSON array passed.
protected String	getTypeKey()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJsonModelFactory

public AbstractJsonModelFactory(String typeKey)

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. When you are parsing an object as a field of another object, it will not be nested under a type key.

Method Detail

getTypeKey

protected final String getTypeKey()

Returns:

the type key which this object can be nested under.

createFrom

protected abstract T createFrom(JSONObject json)
                         throws JSONException

Parse an instance of the model from a JSONObject.

Parameters:

json - the JSONObject to parse from.

Returns:

an instance of T parsed from json.

Throws:

JSONException - If the model fails to parse.

fromList

public final List<T> fromList(JSONArray jsonArray)
                       throws JSONException

Parse a list of models from the JSON array passed.

Parameters:

jsonArray - the jsonArray to parse from.

Returns:

a List of model instances.

Throws:

JSONException - if any of the models fail to parse.

from

public final T from(JSONObject jsonObject)
             throws JSONException

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.

Throws:

JSONException - if the model fails to parse.