Module io.cloudevents.api

Package io.cloudevents.rw

Interface CloudEventWriter<R>

Type Parameters:

R - return value at the end of the write process

All Superinterfaces:

CloudEventContextWriter

public interface CloudEventWriter<R>
extends CloudEventContextWriter

Interface to write the content (CloudEvents attributes, extensions and payload) from a CloudEventReader to a new representation.

Method Summary

Modifier and Type	Method	Description
R	end()	End the write.
R	end(CloudEventData data)	End the write with a data payload.

Methods inherited from interface io.cloudevents.rw.CloudEventContextWriter

withContextAttribute, withContextAttribute, withContextAttribute, withContextAttribute, withContextAttribute, withContextAttribute, withContextAttribute

Method Details

end

R end(CloudEventData data)
throws CloudEventRWException

End the write with a data payload.

Parameters:

data - the data to write

Returns:

an eventual return value

Throws:

CloudEventRWException - if the message writer cannot be ended.

end

R end()
throws CloudEventRWException

End the write.

Returns:

an eventual return value

Throws:

CloudEventRWException - if the message writer cannot be ended.