io.cloudevents.core.builder

Interface CloudEventBuilder

All Superinterfaces:

CloudEventAttributesWriter, CloudEventExtensionsWriter, CloudEventWriter<CloudEvent>

All Known Implementing Classes:

BaseCloudEventBuilder, CloudEventBuilder, CloudEventBuilder

@ParametersAreNullableByDefault
public interface CloudEventBuilder
extends CloudEventWriter<CloudEvent>

Builder interface to build a CloudEvent.

Method Summary

Modifier and Type	Method and Description
CloudEvent	build() Build the event
static CloudEventBuilder	fromSpecVersion(SpecVersion version) Create a new builder for the specified SpecVersion
CloudEventBuilder	newBuilder() Copy this builder, creating a new instance with same values.
static CloudEventBuilder	v03()
static CloudEventBuilder	v03(CloudEvent event)
static CloudEventBuilder	v1()
static CloudEventBuilder	v1(CloudEvent event)
CloudEventBuilder	withData(byte[] data) Set the data of the event
CloudEventBuilder	withData(String dataContentType, byte[] data) Set the datacontenttype and data of the event
CloudEventBuilder	withData(String dataContentType, URI dataSchema, byte[] data) Set the datacontenttype, dataschema and data of the event
CloudEventBuilder	withDataContentType(String dataContentType) Set the datacontenttype of the event
CloudEventBuilder	withDataSchema(URI dataSchema) Set the dataschema of the event.
CloudEventBuilder	withExtension(Extension extension) Add to the builder all the extension key/values of the provided extension
CloudEventBuilder	withExtension(String key, boolean value) Set an extension with provided key and boolean value
CloudEventBuilder	withExtension(String key, Number value) Set an extension with provided key and numeric value
CloudEventBuilder	withExtension(String key, String value) Set an extension with provided key and string value
CloudEventBuilder	withId(String id) Set the id of the event
CloudEventBuilder	withSource(URI source) Set the source of the event
CloudEventBuilder	withSubject(String subject) Set the subject of the event
CloudEventBuilder	withTime(ZonedDateTime time) Set the time of the event
CloudEventBuilder	withType(String type) Set the type of the event

Methods inherited from interface io.cloudevents.rw.CloudEventWriter

end, end

Methods inherited from interface io.cloudevents.rw.CloudEventAttributesWriter

setAttribute, setAttribute, setAttribute

Methods inherited from interface io.cloudevents.rw.CloudEventExtensionsWriter

setExtension, setExtension, setExtension

Method Detail

withId

CloudEventBuilder withId(String id)

Set the id of the event

Parameters:

id - id of the event

Returns:

self

withSource

CloudEventBuilder withSource(URI source)

Set the source of the event

Parameters:

source - source of the event

Returns:

self

withType

CloudEventBuilder withType(String type)

Set the type of the event

Parameters:

type - type of the event

Returns:

self

withDataSchema

CloudEventBuilder withDataSchema(URI dataSchema)

Set the dataschema of the event. For CloudEvent v0.3, this will configure the schemaurl attribute.

Parameters:

dataSchema - dataschema of the event

Returns:

self

withDataContentType

CloudEventBuilder withDataContentType(String dataContentType)

Set the datacontenttype of the event

Parameters:

dataContentType - datacontenttype of the event

Returns:

self

withSubject

CloudEventBuilder withSubject(String subject)

Set the subject of the event

Parameters:

subject - subject of the event

Returns:

self

withTime

CloudEventBuilder withTime(ZonedDateTime time)

Set the time of the event

Parameters:

time - time of the event

Returns:

self

withData

CloudEventBuilder withData(byte[] data)

Set the data of the event

Parameters:

data - data of the event

Returns:

self

withData

CloudEventBuilder withData(String dataContentType,
                           byte[] data)

Set the datacontenttype and data of the event

Parameters:

dataContentType - datacontenttype of the event

data - data of the event

Returns:

self

withData

CloudEventBuilder withData(String dataContentType,
                           URI dataSchema,
                           byte[] data)

Set the datacontenttype, dataschema and data of the event

Parameters:

dataContentType - datacontenttype of the event

dataSchema - dataschema of the event

data - data of the event

Returns:

self

withExtension

CloudEventBuilder withExtension(@Nonnull
                                String key,
                                String value)

Set an extension with provided key and string value

Parameters:

key - key of the extension attribute

value - value of the extension attribute

Returns:

self

withExtension

CloudEventBuilder withExtension(@Nonnull
                                String key,
                                Number value)

Set an extension with provided key and numeric value

Parameters:

key - key of the extension attribute

value - value of the extension attribute

Returns:

self

withExtension

CloudEventBuilder withExtension(@Nonnull
                                String key,
                                boolean value)

Set an extension with provided key and boolean value

Parameters:

key - key of the extension attribute

value - value of the extension attribute

Returns:

self

withExtension

CloudEventBuilder withExtension(@Nonnull
                                Extension extension)

Add to the builder all the extension key/values of the provided extension

Parameters:

extension - materialized extension to set in the event

Returns:

self

build

CloudEvent build()
          throws IllegalStateException

Build the event

Returns:

the built event

Throws:

IllegalStateException - if a required attribute is not configured

newBuilder

CloudEventBuilder newBuilder()

Copy this builder, creating a new instance with same values.

Returns:

A new builder with same values of this instance

v1

static CloudEventBuilder v1()

Returns:

a new CloudEvent v1 builder

v1

static CloudEventBuilder v1(@Nonnull
                            CloudEvent event)

Parameters:

event - event to bootstrap the builder

Returns:

a new CloudEvent v1 builder filled with content of event

v03

static CloudEventBuilder v03()

Returns:

a new CloudEvent v0.3 builder

v03

static CloudEventBuilder v03(@Nonnull
                             CloudEvent event)

Parameters:

event - event to bootstrap the builder

Returns:

a new CloudEvent v0.3 builder filled with content of event

fromSpecVersion

static CloudEventBuilder fromSpecVersion(@Nonnull
                                         SpecVersion version)

Create a new builder for the specified SpecVersion

Parameters:

version - version to use for the new builder

Returns:

a new builder