PayloadConverter (gateway-framework-api 2.3.0 API)

Type Parameters:

I - the input value type to convert from

O - the output value type to convert to.
```
public interface PayloadConverter<I,O>
```
The base interface that a payload converter implements.
For full details about payload converters see the Package Guide.

Author:

DiffusionData Limited

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AVRO_BYTES_TO_JSON` The name of payload converter that converts an Avro byte array to the Diffusion JSON topic format.
`static String`	`AVRO_TO_AVRO_BYTES` The name of payload converter that converts an Avro value to an Avro byte array.
`static String`	`AVRO_TO_JSON` The name of payload converter that converts an Avro value to the Diffusion `TopicType.JSON` topic format.
`static String`	`AVRO_TO_JSON_STRING` The name of payload converter that converts an Avro value to a JSON String.
`static String`	`BINARY_TOPIC_TO_BYTE_ARRAY` The name of payload converter that converts the Diffusion `TopicType.BINARY` topic type to a byte array.
`static String`	`CSV_TO_JSON` The name of payload converter that converts CSV data to the Diffusion `TopicType.JSON` topic format.
`static com.pushtechnology.diffusion.datatype.DataTypes`	`DATA_TYPES` Diffusion datatype implementation that can be used to create Diffusion topic types.
`static com.pushtechnology.diffusion.datatype.json.JSONDataType`	`JSON_DATA_TYPE` JSON datatype implementation.
`static String`	`JSON_TO_AVRO` The name of payload converter that converts the Diffusion `TopicType.JSON` topic format to an Avro format.
`static String`	`JSON_TO_CSV` The name of this payload converter that converts the Diffusion `TopicType.JSON` topic format to CSV string.
`static String`	`JSON_TO_STRING` The name of payload converter that converts the Diffusion `TopicType.JSON` topic format to a String.
`static String`	`OBJECT_TO_BINARY_TOPIC` The name of payload converter that converts an Object to the Diffusion `TopicType.BINARY` topic type.
`static String`	`OBJECT_TO_DOUBLE` The name of payload converter that converts an Object to a Double.
`static String`	`OBJECT_TO_JSON` The name of payload converter that converts an Object to the Diffusion `TopicType.JSON` topic format.
`static String`	`OBJECT_TO_LONG` The name of payload converter that converts an Object to a Long.
`static String`	`OBJECT_TO_STRING` The name of payload converter that converts an Object to a String.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method and Description

O convert(I input)
Converts an input value of type 'I' to an output value of type 'O'.

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`O`	`convert(I input)` Converts an input value of type 'I' to an output value of type 'O'.

- Field Detail
  - DATA_TYPES
```
static final com.pushtechnology.diffusion.datatype.DataTypes DATA_TYPES
```
    Diffusion datatype implementation that can be used to create Diffusion topic types.
  - JSON_DATA_TYPE
```
static final com.pushtechnology.diffusion.datatype.json.JSONDataType JSON_DATA_TYPE
```
    JSON datatype implementation.
  - OBJECT_TO_JSON
```
static final String OBJECT_TO_JSON
```
    The name of payload converter that converts an Object to the Diffusion TopicType.JSON topic format.
    Supported input values include basic POJOs, primitives, and collections such as Map and List.
    
    See Also:
    
    Constant Field Values
  - JSON_TO_STRING
```
static final String JSON_TO_STRING
```
    The name of payload converter that converts the Diffusion TopicType.JSON topic format to a String.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - OBJECT_TO_STRING
```
static final String OBJECT_TO_STRING
```
    The name of payload converter that converts an Object to a String.
    This can be used to publish to the Diffusion TopicType.STRING topic type.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - OBJECT_TO_LONG
```
static final String OBJECT_TO_LONG
```
    The name of payload converter that converts an Object to a Long.
    This can be used to publish to the Diffusion TopicType.INT64 topic type.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - OBJECT_TO_DOUBLE
```
static final String OBJECT_TO_DOUBLE
```
    The name of payload converter that converts an Object to a Double.
    This can be used to publish to the Diffusion TopicType.DOUBLE topic type.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - OBJECT_TO_BINARY_TOPIC
```
static final String OBJECT_TO_BINARY_TOPIC
```
    The name of payload converter that converts an Object to the Diffusion TopicType.BINARY topic type.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - BINARY_TOPIC_TO_BYTE_ARRAY
```
static final String BINARY_TOPIC_TO_BYTE_ARRAY
```
    The name of payload converter that converts the Diffusion TopicType.BINARY topic type to a byte array.
    see the Package Guide for full details of the conversions this converter performs.
    
    See Also:
    
    Constant Field Values
  - AVRO_TO_JSON
```
static final String AVRO_TO_JSON
```
    The name of payload converter that converts an Avro value to the Diffusion TopicType.JSON topic format.
    
    See Also:
    
    Constant Field Values
  - AVRO_TO_JSON_STRING
```
static final String AVRO_TO_JSON_STRING
```
    The name of payload converter that converts an Avro value to a JSON String.
    
    See Also:
    
    Constant Field Values
  - AVRO_TO_AVRO_BYTES
```
static final String AVRO_TO_AVRO_BYTES
```
    The name of payload converter that converts an Avro value to an Avro byte array.
    
    See Also:
    
    Constant Field Values
  - AVRO_BYTES_TO_JSON
```
static final String AVRO_BYTES_TO_JSON
```
    The name of payload converter that converts an Avro byte array to the Diffusion JSON topic format.
    
    See Also:
    
    Constant Field Values
  - JSON_TO_AVRO
```
static final String JSON_TO_AVRO
```
    The name of payload converter that converts the Diffusion TopicType.JSON topic format to an Avro format.
    
    See Also:
    
    Constant Field Values
  - CSV_TO_JSON
```
static final String CSV_TO_JSON
```
    The name of payload converter that converts CSV data to the Diffusion TopicType.JSON topic format.
    
    See Also:
    
    Constant Field Values
  - JSON_TO_CSV
```
static final String JSON_TO_CSV
```
    The name of this payload converter that converts the Diffusion TopicType.JSON topic format to CSV string.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - convert
```
O convert(I input)
   throws PayloadConversionException
```
    Converts an input value of type 'I' to an output value of type 'O'.
    
    Parameters:
    
    input - the unconverted input value
    
    Returns:
    
    converted output value
    
    Throws:
    
    PayloadConversionException - if the converter fails to convert the value

Interface PayloadConverter<I,O>

Field Summary

Method Summary

Field Detail

DATA_TYPES

JSON_DATA_TYPE

OBJECT_TO_JSON

JSON_TO_STRING

OBJECT_TO_STRING

OBJECT_TO_LONG

OBJECT_TO_DOUBLE

OBJECT_TO_BINARY_TOPIC

BINARY_TOPIC_TO_BYTE_ARRAY

AVRO_TO_JSON

AVRO_TO_JSON_STRING

AVRO_TO_AVRO_BYTES

AVRO_BYTES_TO_JSON

JSON_TO_AVRO

CSV_TO_JSON

JSON_TO_CSV

Method Detail

convert