Module io.cloudevents.api

Package io.cloudevents.rw

Interface CloudEventReader

@ParametersAreNonnullByDefault
public interface CloudEventReader

Represents an object that can be read as CloudEvent.

The read may consume this object, hence it's not safe to invoke it multiple times, unless it's explicitly allowed by the implementer.

Method Summary

Modifier and Type	Method	Description
default <W extends CloudEventWriter<R>, R> R	read(CloudEventWriterFactory<W,R> writerFactory)	Like read(CloudEventWriterFactory, CloudEventDataMapper), but with the identity CloudEventDataMapper.
<W extends CloudEventWriter<R>, R> R	read(CloudEventWriterFactory<W,R> writerFactory, CloudEventDataMapper<? extends CloudEventData> mapper)	Read self using the provided writer factory.

Method Details

read

default <W extends CloudEventWriter<R>,
R> R read(CloudEventWriterFactory<W,R> writerFactory)
                                          throws CloudEventRWException

Like read(CloudEventWriterFactory, CloudEventDataMapper), but with the identity CloudEventDataMapper.

Type Parameters:

W - The type of the CloudEventWriter created by writerFactory

R - The return value of the CloudEventWriter created by writerFactory

Parameters:

writerFactory - a factory that generates a visitor starting from the SpecVersion of the event

Returns:

the value returned by CloudEventWriter.end() or CloudEventWriter.end(CloudEventData)

Throws:

CloudEventRWException - if something went wrong during the read.

See Also:

• read(CloudEventWriterFactory, CloudEventDataMapper)

read

<W extends CloudEventWriter<R>,
R> R read(CloudEventWriterFactory<W,R> writerFactory,
 CloudEventDataMapper<? extends CloudEventData> mapper)
                                  throws CloudEventRWException

Read self using the provided writer factory.

Type Parameters:

W - the CloudEventWriter type

R - the return type of the CloudEventWriter

Parameters:

writerFactory - a factory that generates a visitor starting from the SpecVersion of the event

mapper - the mapper to invoke when building the CloudEventData

Returns:

the value returned by CloudEventWriter.end() or CloudEventWriter.end(CloudEventData)

Throws:

CloudEventRWException - if something went wrong during the read.