Merge pull request #257 from avaje/feature/javadoc-serial

Javadoc and serialVersionUID

Author: rbygrave

http-api/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
     <relativePath>..</relativePath>
   </parent>
 

http-api/src/main/java/io/avaje/http/api/DefaultException.java

@@ -1,3 +1,7 @@
 package io.avaje.http.api;
 
-class DefaultException extends Exception {}
+class DefaultException extends Exception {
+
+  private static final long serialVersionUID = 1;
+
+}

http-api/src/main/java/io/avaje/http/api/ExceptionHandler.java

@@ -18,8 +18,8 @@
  *       This also serves as a mapping hint if the annotation itself does not narrow the exception
  *       types through its {@link #value()}.
  *   <li>Request and/or response objects (typically from the microframework). You may choose any
- *       specific request/response type, e.g. Javalin's {@link io.javalin.Context} or Helidon's
- *       Request/ServerResponse.
+ *       specific request/response type, e.g. Javalin's {@code io.javalin.Context} or Helidon's
+ *       ServerRequest/ServerResponse.
  * </ol>
  *
  * <p>Handler methods may be void or return an object for serialization.

http-api/src/main/java/io/avaje/http/api/InvalidPathArgumentException.java

@@ -5,6 +5,8 @@
  */
 public class InvalidPathArgumentException extends InvalidTypeArgumentException {
 
+  private static final long serialVersionUID = 1;
+
   /**
    * Construct with a message.
    */

http-api/src/main/java/io/avaje/http/api/InvalidTypeArgumentException.java

@@ -5,6 +5,8 @@
  */
 public class InvalidTypeArgumentException extends IllegalArgumentException {
 
+  private static final long serialVersionUID = 1;
+
   /**
    * Construct with a message.
    */

http-api/src/main/java/io/avaje/http/api/PathTypeConversion.java

@@ -70,6 +70,7 @@ public static int asInt(String value) {
   }
 
   /** Convert to enum. */
+  @SuppressWarnings({"unchecked", "rawtypes"})
   public static <T> Enum asEnum(Class<T> clazz, String value) {
     checkNull(value);
     try {

http-api/src/main/java/io/avaje/http/api/Post.java

@@ -13,8 +13,9 @@
  *
  *  @Post
  *  void save(Customer customer) {
-      ...
+ *     ...
  *  }
+ * }</pre>
  */
 @Target(METHOD)
 @Retention(RUNTIME)

http-api/src/main/java/io/avaje/http/api/RequiredArgumentException.java

@@ -9,6 +9,8 @@
  */
 public class RequiredArgumentException extends IllegalArgumentException {
 
+  private static final long serialVersionUID = 1;
+
   private String property;
 
   /**

http-api/src/main/java/io/avaje/http/api/ValidationException.java

@@ -1,5 +1,6 @@
 package io.avaje.http.api;
 
+import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -67,7 +68,9 @@ public void setErrors(List<Violation> errors) {
   }
 
   /** Error details including the field, error message and path */
-  public static class Violation {
+  public static class Violation implements Serializable {
+
+    private static final long serialVersionUID = 1;
 
     protected String path;
     protected String field;

http-client-gson-adapter/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-client-gson</artifactId>
@@ -20,7 +20,7 @@
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-http-client</artifactId>
-      <version>2.0-RC2</version>
+      <version>2.0-RC3</version>
       <scope>provided</scope>
     </dependency>
 

http-client/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-client</artifactId>

http-generator-client/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-client-generator</artifactId>

http-generator-core/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-generator-core</artifactId>

http-generator-core/src/main/java/io/avaje/http/generator/core/PathSegments.java

@@ -106,7 +106,7 @@ public Segment segment(String varName) {
   }
 
   /**
-   * Return full path with <code>{}</code for named path params.
+   * Return full path with <code>{}</code> for named path params.
    */
   public String fullPath() {
     return fullPath("{", "}");

http-generator-helidon/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <artifactId>avaje-http-parent</artifactId>
     <groupId>io.avaje</groupId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-helidon-generator</artifactId>

http-generator-javalin/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-javalin-generator</artifactId>

http-generator-javalin/src/main/java/io/avaje/http/javalin/After.java

@@ -13,8 +13,10 @@
  *
  *  @After
  *  void save(Customer customer) {
- * ...
+ *    ...
  *  }
+ *
+ * }</pre>
  */
 @Target(METHOD)
 @Retention(SOURCE)

http-generator-javalin/src/main/java/io/avaje/http/javalin/Before.java

@@ -13,8 +13,10 @@
  *
  *  @Before
  *  void save(Customer customer) {
- * ...
+ *    ...
  *  }
+ *
+ * }</pre>
  */
 @Target(METHOD)
 @Retention(SOURCE)

http-generator-jex/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>avaje-http-jex-generator</artifactId>

http-inject-plugin/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-http-parent</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
     <relativePath>..</relativePath>
   </parent>
 

pom.xml

@@ -9,7 +9,7 @@
 
   <groupId>io.avaje</groupId>
   <artifactId>avaje-http-parent</artifactId>
-  <version>2.0-RC2</version>
+  <version>2.0-RC3</version>
   <packaging>pom</packaging>
 
   <scm>

tests/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <artifactId>avaje-http-parent</artifactId>
     <groupId>io.avaje</groupId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>tests</artifactId>

tests/test-client-generation/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-client-generation</artifactId>

tests/test-client/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-client</artifactId>

tests/test-javalin-jsonb/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-javalin-jsonb</artifactId>

tests/test-javalin/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-javalin</artifactId>

tests/test-jex/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-jex</artifactId>

tests/test-nima-jsonb/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-nima-jsonb</artifactId>

tests/test-nima/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>tests</artifactId>
-    <version>2.0-RC2</version>
+    <version>2.0-RC3</version>
   </parent>
 
   <artifactId>test-nima</artifactId>