Skip to content

Commit b68f585

Browse files
Better docs on the Extensions
Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
1 parent eb644c9 commit b68f585

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

api/src/main/java/io/cloudevents/CloudEventExtensions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface CloudEventExtensions {
3434
* Get the extension attribute named {@code extensionName}
3535
*
3636
* @param extensionName the extension name
37-
* @return the extension value or null if this instance doesn't contain such extension
37+
* @return the extension value in one of the valid types String/Number/Boolean or null if this instance doesn't contain such extension
3838
*/
3939
@Nullable
4040
Object getExtension(String extensionName);

api/src/main/java/io/cloudevents/Extension.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@
2929
public interface Extension {
3030

3131
/**
32-
* Fill this materialized extension with values from a {@link CloudEventExtensions} implementation
32+
* Fill this materialized extension with values from a {@link CloudEventExtensions} implementation.
3333
*
34-
* @param extensions
34+
* @param extensions the extensions where to read from
3535
*/
3636
void readFrom(CloudEventExtensions extensions);
3737

3838
/**
39-
* Get the attribute of extension named {@code key}
39+
* Get the attribute of extension named {@code key}.
4040
*
4141
* @param key the name of the extension attribute
42-
* @return the extension value
42+
* @return the extension value in one of the valid types String/Number/Boolean
4343
* @throws IllegalArgumentException if the key is unknown to this extension
4444
*/
4545
@Nullable

0 commit comments

Comments
 (0)