Module io.cloudevents.core

Package io.cloudevents.core.message

Interface StructuredMessageReader

All Known Subinterfaces:

MessageReader

All Known Implementing Classes:

BaseBinaryMessageReader, BaseGenericBinaryMessageReaderImpl, BaseStructuredMessageReader, GenericStructuredMessageReader

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@ParametersAreNonnullByDefault
public interface StructuredMessageReader

Represents a CloudEvent message in structured mode.

Method Summary

Modifier and Type	Method	Description
static StructuredMessageReader	from(io.cloudevents.CloudEvent event, EventFormat format)	Create a generic structured message from a CloudEvent.
static StructuredMessageReader	from(io.cloudevents.CloudEvent event, String contentType)	Create a generic structured message from a CloudEvent.
<R> R	read(StructuredMessageWriter<R> writer)	Read self using the provided writer.
default io.cloudevents.CloudEvent	toEvent()
default io.cloudevents.CloudEvent	toEvent(io.cloudevents.rw.CloudEventDataMapper<? extends io.cloudevents.CloudEventData> mapper)

Method Details

read

<R> R read(StructuredMessageWriter<R> writer)
    throws io.cloudevents.rw.CloudEventRWException,
IllegalStateException

Read self using the provided writer.

Type Parameters:

R - the return type of the StructuredMessageWriter

Parameters:

writer - the writer to use to write out the message

Returns:

the return value returned by StructuredMessageWriter.setEvent(EventFormat, byte[])

Throws:

io.cloudevents.rw.CloudEventRWException - If something went wrong when

IllegalStateException - If the message is not a valid structured message

toEvent

default io.cloudevents.CloudEvent toEvent()
                                   throws io.cloudevents.rw.CloudEventRWException,
IllegalStateException

Throws:

io.cloudevents.rw.CloudEventRWException

IllegalStateException

toEvent

default io.cloudevents.CloudEvent toEvent(io.cloudevents.rw.CloudEventDataMapper<? extends io.cloudevents.CloudEventData> mapper)
                                   throws io.cloudevents.rw.CloudEventRWException,
IllegalStateException

Throws:

io.cloudevents.rw.CloudEventRWException

IllegalStateException

from

static StructuredMessageReader from(io.cloudevents.CloudEvent event,
 String contentType)

Create a generic structured message from a CloudEvent.

Parameters:

event - the event to convert to StructuredMessageReader

contentType - content type to use to resolve the EventFormat

Returns:

null if format was not found, otherwise returns the built message

from

static StructuredMessageReader from(io.cloudevents.CloudEvent event,
 EventFormat format)

Create a generic structured message from a CloudEvent.

Parameters:

event - the event to convert to StructuredMessageReader

format - the format to use to perform the conversion

Returns:

null if format was not found, otherwise returns the built message