Package io.temporal.common.converter

Class ProtobufPayloadConverter

java.lang.Object

io.temporal.common.converter.AbstractProtobufPayloadConverter

io.temporal.common.converter.ProtobufPayloadConverter

All Implemented Interfaces:

PayloadConverter

public final class ProtobufPayloadConverter
extends AbstractProtobufPayloadConverter
implements PayloadConverter

Field Summary

Fields inherited from class io.temporal.common.converter.AbstractProtobufPayloadConverter

log

Constructor Summary

Constructors

Constructor	Description
ProtobufPayloadConverter()
ProtobufPayloadConverter(boolean excludeProtobufMessageTypes)

Method Summary

Modifier and Type	Method	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()	Each PayloadConverter has an Encoding Type that it handles.
java.util.Optional<io.temporal.api.common.v1.Payload>	toData(java.lang.Object value)	Implements conversion of a list of values.

Methods inherited from class io.temporal.common.converter.AbstractProtobufPayloadConverter

addMessageType, checkMessageType

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 Detail

ProtobufPayloadConverter

public ProtobufPayloadConverter()

ProtobufPayloadConverter

public ProtobufPayloadConverter(boolean excludeProtobufMessageTypes)

Method Detail

getEncodingType

public java.lang.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 java.util.Optional<io.temporal.api.common.v1.Payload> toData(java.lang.Object value)
                                                             throws DataConverterException

Description copied from interface: PayloadConverter

Implements conversion of a list of values.

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,
                      java.lang.Class<T> valueClass,
                      java.lang.reflect.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.