io.gsonfire

Class GsonFireBuilder

java.lang.Object

io.gsonfire.GsonFireBuilder

public final class GsonFireBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
GsonFireBuilder()

Method Summary

Modifier and Type	Method and Description
GsonFireBuilder	addSerializationExclusionStrategy(FireExclusionStrategy exclusionStrategy)
com.google.gson.Gson	createGson() Returns a new Gson instance
com.google.gson.GsonBuilder	createGsonBuilder() Returns a new instance of the good old GsonBuilder
GsonFireBuilder	dateSerializationPolicy(DateSerializationPolicy policy) Configures the resulting Gson to serialize/unserialize Date instances with a policy
GsonFireBuilder	enableExclusionByValue() By enabling this, all exclusion by value strategies specified with the annotation ExcludeByValue will be run to remove specific fields from the resulting json
GsonFireBuilder	enableExposeMethodResult() By enabling this, all methods with the annotation ExposeMethodResult will be evaluated and it result will be added to the resulting json
GsonFireBuilder	enableHooks(Class clazz) By enabling this, all methods with the annotation ExposeMethodResult will be evaluated and it result will be added to the resulting json
GsonFireBuilder	enableMergeMaps(Class clazz) Deprecated.
<T> GsonFireBuilder	registerPostProcessor(Class<T> clazz, PostProcessor<? super T> postProcessor) Registers a Post processor for the Class specified.
<T> GsonFireBuilder	registerPreProcessor(Class<T> clazz, PreProcessor<? super T> preProcessor) Registers a pre processor for the Class specified.
<T> GsonFireBuilder	registerTypeSelector(Class<T> clazz, TypeSelector<T> factory) Registers a Type selector for the Class specified.
GsonFireBuilder	serializeTimeZone(TimeZone timeZone) Sets the serialization TimeZone.

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonFireBuilder

public GsonFireBuilder()

Method Detail

registerTypeSelector

public <T> GsonFireBuilder registerTypeSelector(Class<T> clazz,
                                                TypeSelector<T> factory)

Registers a Type selector for the Class specified.
A type selector is in charge of deciding which sub class to use when converting a json into an object.
See docs and example

Type Parameters:

T -

Parameters:

clazz -

factory -

Returns:

registerPostProcessor

public <T> GsonFireBuilder registerPostProcessor(Class<T> clazz,
                                                 PostProcessor<? super T> postProcessor)

Registers a Post processor for the Class specified.
A post processor is a class that will add new fields to a generated json just after generation, or that will prepare a class just created from a json.
See docs and example

Type Parameters:

T -

Parameters:

clazz -

postProcessor -

Returns:

registerPreProcessor

public <T> GsonFireBuilder registerPreProcessor(Class<T> clazz,
                                                PreProcessor<? super T> preProcessor)

Registers a pre processor for the Class specified.
A pre processor is a class that will be given the gson to be deserialized in case it wants to change it before it actually gets deserialized into a class See docs and example

Type Parameters:

T -

Parameters:

clazz -

preProcessor -

Returns:

dateSerializationPolicy

public GsonFireBuilder dateSerializationPolicy(DateSerializationPolicy policy)

Configures the resulting Gson to serialize/unserialize Date instances with a policy

Parameters:

policy -

Returns:

enableExposeMethodResult

public GsonFireBuilder enableExposeMethodResult()

By enabling this, all methods with the annotation ExposeMethodResult will be evaluated and it result will be added to the resulting json

Returns:

enableExclusionByValue

public GsonFireBuilder enableExclusionByValue()

By enabling this, all exclusion by value strategies specified with the annotation ExcludeByValue will be run to remove specific fields from the resulting json

Returns:

enableHooks

public GsonFireBuilder enableHooks(Class clazz)

By enabling this, all methods with the annotation ExposeMethodResult will be evaluated and it result will be added to the resulting json

Returns:

enableMergeMaps

@Deprecated
public GsonFireBuilder enableMergeMaps(Class clazz)

Deprecated.

By enabling this, when a class is being converted to Json and it contains a Map class annotated with MergeMap, the map will be walked and merged with the resulting json object. This method has been deprecated and a PostProcessor should be used instead

Returns:

serializeTimeZone

public GsonFireBuilder serializeTimeZone(TimeZone timeZone)

Sets the serialization TimeZone. This will affect only values that depend on the TimeZone, for example rfc3339 dates.

Parameters:

timeZone -

Returns:

addSerializationExclusionStrategy

public GsonFireBuilder addSerializationExclusionStrategy(FireExclusionStrategy exclusionStrategy)

createGsonBuilder

public com.google.gson.GsonBuilder createGsonBuilder()

Returns a new instance of the good old GsonBuilder

Returns:

createGson

public com.google.gson.Gson createGson()

Returns a new Gson instance

Returns: