Class GsonJsonPayloadConverter

java.lang.Object

io.temporal.common.converter.GsonJsonPayloadConverter

All Implemented Interfaces:

PayloadConverter

public final class GsonJsonPayloadConverter
extends Object
implements PayloadConverter

Implements conversion through GSON JSON processor. To extend use GsonJsonPayloadConverter(Function) constructor.

Constructor Summary

Constructors

Constructor	Description
GsonJsonPayloadConverter()
GsonJsonPayloadConverter(Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder> builderInterceptor)	Constructs an instance giving an ability to override Gson initialization.

Method Summary

Modifier and Type	Method	Description
<T> T	fromData(io.temporal.api.common.v1.Payload content, Class<T> valueClass, Type valueType)	Implements conversion of a single value.
String	getEncodingType()	Each PayloadConverter has an Encoding Type that it handles.
static PayloadConverter	getInstance()
Optional<io.temporal.api.common.v1.Payload>	toData(Object value)	Return empty if value is null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.temporal.common.converter.PayloadConverter

withContext

Constructor Details

GsonJsonPayloadConverter

public GsonJsonPayloadConverter()

GsonJsonPayloadConverter

public GsonJsonPayloadConverter(Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder> builderInterceptor)

Constructs an instance giving an ability to override Gson initialization.

Parameters:

builderInterceptor - function that intercepts GsonBuilder construction.

Method Details

getInstance

public static PayloadConverter getInstance()

getEncodingType

public String getEncodingType()

Description copied from interface: PayloadConverter

Each PayloadConverter has an Encoding Type that it handles. Each PayloadConverter should add the information about its Encoding Type into the Payload it produces inside PayloadConverter.toData(Object) by associating it with the EncodingKeys.METADATA_ENCODING_KEY key attached to the Payload's Metadata using Payload.Builder.putMetadata(String, ByteString).

Specified by:

getEncodingType in interface PayloadConverter

Returns:

encoding type that this converter handles.

toData

public Optional<io.temporal.api.common.v1.Payload> toData(Object value)
                                                   throws DataConverterException

Return empty if value is null. Exception stack traces are converted to a single string stack trace to save space and make them more readable.

Specified by:

toData in interface PayloadConverter

Parameters:

value - Java value to convert.

Returns:

converted value

Throws:

DataConverterException - if conversion of the value passed as parameter failed for any reason.

See Also:

• getEncodingType javadoc for an important implementation detail

fromData

public <T> T fromData(io.temporal.api.common.v1.Payload content,
 Class<T> valueClass,
 Type valueType)
               throws DataConverterException

Description copied from interface: PayloadConverter

Implements conversion of a single value.

Specified by:

fromData in interface PayloadConverter

Parameters:

content - Serialized value to convert to a Java object.

valueClass - type of the value stored in the content

valueType - generic type of the value stored in the content

Returns:

converted Java object

Throws:

DataConverterException - if conversion of the data passed as parameter failed for any reason.