io.cloudevents.v02

Class CloudEventBuilder<T>

java.lang.Object

io.cloudevents.v02.CloudEventBuilder<T>

All Implemented Interfaces:

Builder<AttributesImpl,T>, EventBuilder<T,AttributesImpl>

public class CloudEventBuilder<T>
extends Object
implements EventBuilder<T,AttributesImpl>, Builder<AttributesImpl,T>

CloudEvent instances builder

Version:

0.2

Author:

fabiojose

Method Summary

Modifier and Type	Method and Description
CloudEventImpl<T>	build() To build a brand new instance of CloudEvent
<TT> CloudEvent<AttributesImpl,TT>	build(CloudEvent<AttributesImpl,T> base, String id, TT newData) To build a brand new instance of CloudEvent with another type of 'data'
CloudEvent<AttributesImpl,T>	build(T data, AttributesImpl attributes, Collection<ExtensionFormat> extensions) Builds a new event using 'data', 'attributes' and 'extensions'
static <T> CloudEventBuilder<T>	builder() Gets a brand new builder instance
static <T> CloudEventBuilder<T>	builder(CloudEvent<AttributesImpl,T> base)
static <T> CloudEventImpl<T>	of(T data, AttributesImpl attributes, Collection<ExtensionFormat> extensions)
CloudEventBuilder<T>	withContenttype(String contenttype)
CloudEventBuilder<T>	withData(T data)
CloudEventBuilder<T>	withExtension(ExtensionFormat extension)
CloudEventBuilder<T>	withId(String id)
CloudEventBuilder<T>	withSchemaurl(URI schemaurl)
CloudEventBuilder<T>	withSource(URI source)
CloudEventBuilder<T>	withTime(ZonedDateTime time)
CloudEventBuilder<T>	withType(String type)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <T> CloudEventBuilder<T> builder()

Gets a brand new builder instance

Type Parameters:

T - The 'data' type

builder

public static <T> CloudEventBuilder<T> builder(CloudEvent<AttributesImpl,T> base)

Type Parameters:

T - The 'data' type

Parameters:

base - A base event to copy CloudEvent.getAttributes(), CloudEvent.getData() and CloudEvent.getExtensions()

Returns:

of

public static <T> CloudEventImpl<T> of(T data,
                                       AttributesImpl attributes,
                                       Collection<ExtensionFormat> extensions)

Type Parameters:

T - the type of 'data'

Parameters:

data - the value of data

attributes - the context attributes

Returns:

An new CloudEventImpl immutable instance

Throws:

IllegalStateException - When there are specification constraints violations

build

public CloudEvent<AttributesImpl,T> build(T data,
                                          AttributesImpl attributes,
                                          Collection<ExtensionFormat> extensions)

Description copied from interface: EventBuilder

Builds a new event using 'data', 'attributes' and 'extensions'

Specified by:

build in interface EventBuilder<T,AttributesImpl>

build

public CloudEventImpl<T> build()

To build a brand new instance of CloudEvent

Specified by:

build in interface Builder<AttributesImpl,T>

Returns:

An new CloudEventImpl immutable instance

Throws:

IllegalStateException - When there are specification constraints violations

withType

public CloudEventBuilder<T> withType(String type)

withId

public CloudEventBuilder<T> withId(String id)

withSource

public CloudEventBuilder<T> withSource(URI source)

withTime

public CloudEventBuilder<T> withTime(ZonedDateTime time)

withSchemaurl

public CloudEventBuilder<T> withSchemaurl(URI schemaurl)

withContenttype

public CloudEventBuilder<T> withContenttype(String contenttype)

withData

public CloudEventBuilder<T> withData(T data)

withExtension

public CloudEventBuilder<T> withExtension(ExtensionFormat extension)

build

public <TT> CloudEvent<AttributesImpl,TT> build(CloudEvent<AttributesImpl,T> base,
                                                String id,
                                                TT newData)

To build a brand new instance of CloudEvent with another type of 'data'

Specified by:

build in interface Builder<AttributesImpl,T>

Type Parameters:

TT - The new type of 'data'

Parameters:

base - The base CloudEvent to copy its attributes

id - The new id for the new instance

newData - The new 'data'