Module io.cloudevents.api

Package io.cloudevents

Interface CloudEventExtension

@ParametersAreNonnullByDefault
public interface CloudEventExtension

Materialized CloudEvent extension interface to read/write the extension attributes key/values.

Method Summary

Modifier and Type	Method	Description
Set<String>	getKeys()	Get the set of possible extension attribute keys
Object	getValue(String key)	Get the attribute of extension named key.
void	readFrom(CloudEventExtensions extensions)	Fill this materialized extension with values from a CloudEventExtensions implementation.

Method Details

readFrom

void readFrom(CloudEventExtensions extensions)

Fill this materialized extension with values from a CloudEventExtensions implementation.

Parameters:

extensions - the extensions where to read from

getValue

@Nullable
Object getValue(String key)
         throws IllegalArgumentException

Get the attribute of extension named key.

Parameters:

key - the name of the extension attribute

Returns:

the extension value in one of the valid types String/Number/Boolean/URI/OffsetDateTime/byte[]

Throws:

IllegalArgumentException - if the key is unknown to this extension

getKeys

Set<String> getKeys()

Get the set of possible extension attribute keys

Returns:

set of possible extension attribute keys