sdk-java/api
Francesco Guardiani f5d9b47c1c
Javadocs api and core (#313)
* Javadocs!!!

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Missing module name?

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Excluding javadocs

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* clean install only release artifacts, but verify them all!

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Reverted the crazy idea to use the release profile

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Suggestions

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Suggestion

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Nit

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Nit

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

* Nit

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
2020-12-09 18:31:56 +01:00
..
src Javadocs api and core (#313) 2020-12-09 18:31:56 +01:00
README.md
pom.xml Bump to 2.0.0-SNAPSHOT (#310) 2020-11-26 16:48:45 +01:00

README.md

CloudEvents API

Javadocs

For Maven based projects, use the following dependency:

<dependency>
    <groupId>io.cloudevents</groupId>
    <artifactId>cloudevents-api</artifactId>
    <version>2.0.0.RC1</version>
</dependency>

Features

This package provides the base interfaces used by the SDK. In particular:

  • CloudEvent is the main interface representing a read only CloudEvent in-memory representation
  • Extension represents a materialized in-memory representation of a CloudEvent extension
  • SpecVersion is an enum of CloudEvents' specification versions supported by this SDK version.
  • CloudEventVisitor/CloudEventVisitable are the interfaces used by the SDK to implement protocol bindings/event formats. A 3rd party implementer can implement these interfaces directly in its CloudEvent in order to customize/implement efficiently the marshalling/unmarshalling process. These interfaces are optional and, if your CloudEvent doesn't implement it, a default implementation is provided by the SDK.

cloudevents-core provides the implementation of these interfaces, and a 3rd party implementer can grab this package to implement specialized CloudEvent in-memory representations.