Added javadoc for jax-rs (#184)

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

Author: slinkydeveloper

http/restful-ws/README.md

@@ -19,7 +19,8 @@ You need to configure the `CloudEventsProvider` to enable marshalling/unmarshall
 Below is a sample on how to read and write CloudEvents:
 
 ```java
-import io.cloudevents.CloudEvent;import io.cloudevents.core.builder.CloudEventBuilder;
+import io.cloudevents.CloudEvent;
+import io.cloudevents.core.builder.CloudEventBuilder;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;

http/restful-ws/src/main/java/io/cloudevents/http/restful/ws/BinaryEncoding.java

@@ -22,6 +22,10 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Annotate a method with this annotation to specify that you want to write the returned event
+ * in binary mode.
+ */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface BinaryEncoding {

http/restful-ws/src/main/java/io/cloudevents/http/restful/ws/CloudEventsProvider.java

@@ -46,11 +46,17 @@
 import java.util.Arrays;
 import java.util.Optional;
 
+/**
+ * This provider implements {@link CloudEvent} encoding and decoding for Jax-Rs Resources and {@link javax.ws.rs.client.Client}
+ */
 @Provider
 @Consumes(MediaType.WILDCARD)
 @Produces(MediaType.WILDCARD)
 public class CloudEventsProvider implements MessageBodyReader<CloudEvent>, MessageBodyWriter<CloudEvent>, ClientRequestFilter {
 
+    /**
+     * The content type to use when sending {@link CloudEvent} with {@link javax.ws.rs.client.Client}
+     */
     public static MediaType CLOUDEVENT_TYPE = MediaType.valueOf("application/cloudevents");
 
     @Override

http/restful-ws/src/main/java/io/cloudevents/http/restful/ws/StructuredEncoding.java

@@ -22,8 +22,16 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Annotate a method with this annotation to specify that you want to write the returned event
+ * in structured mode.
+ */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface StructuredEncoding {
+    /**
+     * Specify the content type of the structured mode
+     * (used to resolve the {@link io.cloudevents.core.format.EventFormat} through the {@link io.cloudevents.core.provider.EventFormatProvider})
+     */
     String value();
 }