io.temporal.common.converter

Interface PayloadConverter

All Known Implementing Classes:

ByteArrayPayloadConverter, GsonJsonPayloadConverter, JacksonJsonPayloadConverter, NullPayloadConverter, ProtobufJsonPayloadConverter, ProtobufPayloadConverter

public interface PayloadConverter

Used by the framework to serialize/deserialize method parameters that need to be sent over the wire.

Method Summary

Modifier and Type	Method and Description
<T> T	fromData(io.temporal.api.common.v1.Payload content, java.lang.Class<T> valueClass, java.lang.reflect.Type valueType) Implements conversion of a single value.
java.lang.String	getEncodingType()
java.util.Optional<io.temporal.api.common.v1.Payload>	toData(java.lang.Object value) Implements conversion of a list of values.

Method Detail

getEncodingType

java.lang.String getEncodingType()

toData

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

Implements conversion of a list of values.

Parameters:

value - Java value to convert.

Returns:

converted value

Throws:

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

fromData

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

Implements conversion of a single value.

Parameters:

content - Serialized value to convert to a Java object.

valueClass -

valueType -

Returns:

converted Java object

Throws:

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