-
Notifications
You must be signed in to change notification settings - Fork 166
Javadocs api and core #313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Javadocs api and core #313
Conversation
573b60d to
18945ab
Compare
core/src/main/java/io/cloudevents/core/extensions/impl/ExtensionUtils.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
core/src/main/java/io/cloudevents/core/message/MessageReader.java
Outdated
Show resolved
Hide resolved
|
|
||
| /** | ||
| * Visit the message as structured encoded event using the provided visitor | ||
| * Read the message as structured encoded message using the provided reader |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above.
5362f88 to
362e1bd
Compare
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
core/src/main/java/io/cloudevents/core/message/MessageReader.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
| <T> T read(StructuredMessageWriter<T> visitor) throws CloudEventRWException, IllegalStateException; | ||
| <R> R read(StructuredMessageWriter<R> writer) throws CloudEventRWException, IllegalStateException; | ||
|
|
||
| default CloudEvent toEvent() throws CloudEventRWException, IllegalStateException { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see these two methods are documented in extending interface. Why?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean the toEvent() methods.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I expect the user to look in this interface for this method, not in StructuredMessageReader. Does that makes sense?
This PR contains a lot of new javadocs for api and core
Also:
Signed-off-by: Francesco Guardiani francescoguard@gmail.com