io.cloudevents.core.format

Interface EventFormat

@ParametersAreNonnullByDefault
public interface EventFormat

An Event format specifies how to serialize a CloudEvent as a sequence of bytes.

An implementation of this interface should support all specification versions of CloudEvent.

Implementations of this interface can be registered to the EventFormatProvider to use them.

See Also:

EventFormatProvider

Method Summary

Modifier and Type	Method and Description
default Set<String>	deserializableContentTypes()
default CloudEvent	deserialize(byte[] bytes) Like deserialize(byte[], CloudEventDataMapper), but with the identity CloudEventDataMapper.
CloudEvent	deserialize(byte[] bytes, CloudEventDataMapper<? extends CloudEventData> mapper) Deserialize a byte array to a CloudEvent.
byte[]	serialize(CloudEvent event) Serialize a CloudEvent to a byte array.
String	serializedContentType()

Method Detail

serialize

byte[] serialize(CloudEvent event)
          throws EventSerializationException

Serialize a CloudEvent to a byte array.

Parameters:

event - the event to serialize.

Returns:

the byte representation of the provided event.

Throws:

EventSerializationException - if something goes wrong during serialization.

deserialize

default CloudEvent deserialize(byte[] bytes)
                        throws EventDeserializationException

Like deserialize(byte[], CloudEventDataMapper), but with the identity CloudEventDataMapper.

Throws:

EventDeserializationException

See Also:

deserialize(byte[], CloudEventDataMapper)

deserialize

CloudEvent deserialize(byte[] bytes,
                       CloudEventDataMapper<? extends CloudEventData> mapper)
                throws EventDeserializationException

Deserialize a byte array to a CloudEvent.

Parameters:

bytes - the serialized event.

mapper - the mapper to use to map the data.

Returns:

the deserialized event.

Throws:

EventDeserializationException - if something goes wrong during deserialization.

deserializableContentTypes

default Set<String> deserializableContentTypes()

Returns:

the set of content types this event format can deserialize. These content types are used by the EventFormatProvider to resolve an EventFormat starting from the content type String.

serializedContentType

String serializedContentType()

Returns:

The content type to use when writing an event with this EventFormat.