com.atlassian.marshalling.gson

Class GsonMarshalling<T>

java.lang.Object

com.atlassian.marshalling.gson.BaseGsonMarshalling<T>

com.atlassian.marshalling.gson.GsonMarshalling<T>

Type Parameters:

T - the type being marshalled

All Implemented Interfaces:

com.atlassian.marshalling.api.Marshaller<T>, com.atlassian.marshalling.api.Unmarshaller<T>

@PublicApi
public class GsonMarshalling<T>
extends BaseGsonMarshalling<T>

Marshalling implementation that uses Gson to convert to / from json and StringMarshalling to marshall the String. Users are expected to provide a Gson implementation that is configured appropriately.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
GsonMarshalling(com.google.gson.Gson gson, Class<T> targetClass) Create a Marshaller using the supplied Gson for the specified class
GsonMarshalling(com.google.gson.Gson gson, com.google.gson.reflect.TypeToken<T> typeToken) Create a Marshaller using the supplied Gson for the specified class

Method Summary

Modifier and Type	Method and Description
static <T> com.atlassian.marshalling.api.MarshallingPair<T>	pair(Class<T> targetClass) Returns a MarshallingPair for the given class using default configured Gson.
static <T> com.atlassian.marshalling.api.MarshallingPair<T>	pair(com.google.gson.Gson gson, Class<T> targetClass) Returns a MarshallingPair for the given class using the supplied Gson.
static <T> com.atlassian.marshalling.api.MarshallingPair<T>	pair(com.google.gson.Gson gson, com.google.gson.reflect.TypeToken<T> typeToken) Returns a MarshallingPair for the given class using the supplied Gson.
static <T> com.atlassian.marshalling.api.MarshallingPair<T>	pair(com.google.gson.reflect.TypeToken<T> typeToken) Returns a MarshallingPair for the given class using default configured Gson.

Methods inherited from class com.atlassian.marshalling.gson.BaseGsonMarshalling

getGson, getTypeToken, marshallToBytes, unmarshallFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonMarshalling

public GsonMarshalling(com.google.gson.Gson gson,
                       Class<T> targetClass)

Create a Marshaller using the supplied Gson for the specified class

Parameters:

gson - The Gson instance to use for marshalling

targetClass - The class to marshall

GsonMarshalling

public GsonMarshalling(com.google.gson.Gson gson,
                       com.google.gson.reflect.TypeToken<T> typeToken)

Create a Marshaller using the supplied Gson for the specified class

Parameters:

gson - The Gson instance to use for marshalling

typeToken - The type token to use for the types we are marshalling

Method Detail

pair

public static <T> com.atlassian.marshalling.api.MarshallingPair<T> pair(com.google.gson.Gson gson,
                                                                        Class<T> targetClass)

Returns a MarshallingPair for the given class using the supplied Gson.

Type Parameters:

T - The type of the returned MarshallingPair

Parameters:

gson - The Gson instance to use for marshalling/unmarshalling

targetClass - The type that will be marshalled

Returns:

A marshalling pair that can marshall and unmarshall the supplied class

pair

public static <T> com.atlassian.marshalling.api.MarshallingPair<T> pair(com.google.gson.Gson gson,
                                                                        com.google.gson.reflect.TypeToken<T> typeToken)

Returns a MarshallingPair for the given class using the supplied Gson.

Type Parameters:

T - The type of the returned MarshallingPair

Parameters:

gson - The Gson instance to use for marshalling/unmarshalling

typeToken - The type that will be marshalled

Returns:

A marshalling pair that can marshall and unmarshall the supplied class

pair

public static <T> com.atlassian.marshalling.api.MarshallingPair<T> pair(com.google.gson.reflect.TypeToken<T> typeToken)

Returns a MarshallingPair for the given class using default configured Gson.

Type Parameters:

T - The type of the returned MarshallingPair

Parameters:

typeToken - The type that will be marshalled

Returns:

A marshalling pair that can marshall and unmarshall the supplied class

pair

public static <T> com.atlassian.marshalling.api.MarshallingPair<T> pair(Class<T> targetClass)

Returns a MarshallingPair for the given class using default configured Gson.

Type Parameters:

T - The type of the returned MarshallingPair

Parameters:

targetClass - The type that will be marshalled

Returns:

A marshalling pair that can marshall and unmarshall the supplied class