io.cloudevents.core.v03

Class CloudEventBuilder

java.lang.Object

io.cloudevents.core.impl.BaseCloudEventBuilder<CloudEventBuilder,CloudEventV03>

io.cloudevents.core.v03.CloudEventBuilder

All Implemented Interfaces:

CloudEventBuilder, CloudEventContextWriter, CloudEventWriter<CloudEvent>

public final class CloudEventBuilder
extends BaseCloudEventBuilder<CloudEventBuilder,CloudEventV03>

CloudEvent V0.3 builder.

Author:

fabiojose, slinkydeveloper

Field Summary

Fields inherited from class io.cloudevents.core.impl.BaseCloudEventBuilder

data, extensions

Constructor Summary

Constructors

Constructor and Description
CloudEventBuilder()
CloudEventBuilder(CloudEvent event)
CloudEventBuilder(CloudEventContext context)

Method Summary

Modifier and Type	Method and Description
CloudEventV03	build() Build the event
CloudEventBuilder	newBuilder() Copy this builder, creating a new instance with same values.
protected void	setAttributes(CloudEventContext event)
CloudEventContextWriter	withContextAttribute(String name, Boolean value)
CloudEventContextWriter	withContextAttribute(String name, byte[] value)
CloudEventContextWriter	withContextAttribute(String name, Integer value)
CloudEventContextWriter	withContextAttribute(String name, Number value)
CloudEventContextWriter	withContextAttribute(String name, OffsetDateTime value)
CloudEventContextWriter	withContextAttribute(String name, String value)
CloudEventContextWriter	withContextAttribute(String name, URI value)
CloudEventBuilder	withDataContentType(String dataContentType) Set the datacontenttype of the event
CloudEventBuilder	withDataSchema(URI dataSchema) Set the dataschema of the event.
CloudEventBuilder	withId(String id) Set the id of the event
CloudEventBuilder	withSchemaUrl(URI schemaUrl)
CloudEventBuilder	withSource(URI source) Set the source of the event
CloudEventBuilder	withSubject(String subject) Set the subject of the event
CloudEventBuilder	withTime(OffsetDateTime time) Set the time of the event
CloudEventBuilder	withType(String type) Set the type of the event

Methods inherited from class io.cloudevents.core.impl.BaseCloudEventBuilder

createMissingAttributeException, end, end, requireValidAttributeWrite, withData, withData, withData, withData, withData, withData, withExtension, withExtension, withExtension, withExtension, withExtension, withExtension, withExtension, withoutData, withoutDataContentType, withoutDataSchema, withoutExtension, withoutExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.cloudevents.core.builder.CloudEventBuilder

from, fromContext, fromSpecVersion, v03, v03, v1, v1

Constructor Detail

CloudEventBuilder

public CloudEventBuilder()

CloudEventBuilder

public CloudEventBuilder(CloudEvent event)

CloudEventBuilder

public CloudEventBuilder(CloudEventContext context)

Method Detail

setAttributes

protected void setAttributes(CloudEventContext event)

Specified by:

setAttributes in class BaseCloudEventBuilder<CloudEventBuilder,CloudEventV03>

withId

public CloudEventBuilder withId(String id)

Description copied from interface: CloudEventBuilder

Set the id of the event

Parameters:

id - id of the event

Returns:

self

withSource

public CloudEventBuilder withSource(URI source)

Description copied from interface: CloudEventBuilder

Set the source of the event

Parameters:

source - source of the event

Returns:

self

withType

public CloudEventBuilder withType(String type)

Description copied from interface: CloudEventBuilder

Set the type of the event

Parameters:

type - type of the event

Returns:

self

withTime

public CloudEventBuilder withTime(OffsetDateTime time)

Description copied from interface: CloudEventBuilder

Set the time of the event

Parameters:

time - time of the event

Returns:

self

withSubject

public CloudEventBuilder withSubject(String subject)

Description copied from interface: CloudEventBuilder

Set the subject of the event

Parameters:

subject - subject of the event

Returns:

self

withDataContentType

public CloudEventBuilder withDataContentType(String dataContentType)

Description copied from interface: CloudEventBuilder

Set the datacontenttype of the event

Parameters:

dataContentType - datacontenttype of the event

Returns:

self

withSchemaUrl

public CloudEventBuilder withSchemaUrl(URI schemaUrl)

withDataSchema

public CloudEventBuilder withDataSchema(URI dataSchema)

Description copied from interface: CloudEventBuilder

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

Parameters:

dataSchema - dataschema of the event

Returns:

self

build

public CloudEventV03 build()

Description copied from interface: CloudEventBuilder

Build the event

Returns:

the built event

newBuilder

public CloudEventBuilder newBuilder()

Description copied from interface: CloudEventBuilder

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

Returns:

A new builder with same values of this instance

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    String value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    URI value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    OffsetDateTime value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    Number value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    Integer value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    Boolean value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException

withContextAttribute

public CloudEventContextWriter withContextAttribute(String name,
                                                    byte[] value)
                                             throws CloudEventRWException

Throws:

CloudEventRWException