kotlin: annotated public API with NonNull annotation fix #822

jooby-project · Oct 9, 2017 · 42e42cb · 42e42cb
1 parent 3113ca5
commit 42e42cb
Show file tree

Hide file tree

Showing 21 changed files with 552 additions and 9 deletions.
diff --git a/jooby/pom.xml b/jooby/pom.xml
@@ -94,6 +94,12 @@
   </build>
 
   <dependencies>
+    <dependency>
+      <groupId>com.google.code.findbugs</groupId>
+      <artifactId>jsr305</artifactId>
+      <scope>provided</scope>
+    </dependency>
+
     <!-- Logging System -->
     <dependency>
       <groupId>org.slf4j</groupId>

diff --git a/jooby/src/main/java/org/jooby/Asset.java b/jooby/src/main/java/org/jooby/Asset.java
@@ -211,6 +211,8 @@
 import com.google.common.io.BaseEncoding;
 import com.google.common.primitives.Longs;
 
+import javax.annotation.Nonnull;
+
 /**
  * Usually a public file/resource like javascript, css, images files, etc...
  * An asset consist of content type, stream and last modified since attributes, between others.
@@ -286,6 +288,7 @@ public MediaType type() {
    *
    * @return The asset name (without path).
    */
+  @Nonnull
   default String name() {
     String path = path();
     int slash = path.lastIndexOf('/');
@@ -302,17 +305,20 @@ default String name() {
    *
    * @return The asset requested path, includes the name.
    */
+  @Nonnull
   String path();
 
   /**
    * @return URL representing the resource.
    */
+  @Nonnull
   URL resource();
 
   /**
    * @return Generate a weak Etag using the {@link #path()}, {@link #lastModified()} and
    *         {@link #length()}.
    */
+  @Nonnull
   default String etag() {
     StringBuilder b = new StringBuilder(32);
     b.append("W/\"");
@@ -340,10 +346,12 @@ default String etag() {
    * @return The content of this asset.
    * @throws Exception If content can't be read it.
    */
+  @Nonnull
   InputStream stream() throws Exception;
 
   /**
    * @return Asset media type.
    */
+  @Nonnull
   MediaType type();
 }
diff --git a/jooby/src/main/java/org/jooby/Cookie.java b/jooby/src/main/java/org/jooby/Cookie.java
@@ -210,6 +210,8 @@
 import org.jooby.funzy.Throwing;
 import org.jooby.internal.CookieImpl;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 import javax.crypto.Mac;
 import javax.crypto.spec.SecretKeySpec;
 import java.net.URLDecoder;
@@ -387,6 +389,7 @@ public Definition(final String name) {
      *
      * @return A new cookie.
      */
+    @Nonnull
     public Cookie toCookie() {
       return new CookieImpl(this);
     }
@@ -402,6 +405,7 @@ public String toString() {
      * @param name A cookie's name.
      * @return This definition.
      */
+    @Nonnull
     public Definition name(final String name) {
       this.name = requireNonNull(name, "A cookie name is required.");
       return this;
@@ -410,6 +414,7 @@ public Definition name(final String name) {
     /**
      * @return Cookie's name.
      */
+    @Nonnull
     public Optional<String> name() {
       return Optional.ofNullable(name);
     }
@@ -420,6 +425,7 @@ public Optional<String> name() {
      * @param value A value.
      * @return This definition.
      */
+    @Nonnull
     public Definition value(final String value) {
       this.value = requireNonNull(value, "A cookie value is required.");
       return this;
@@ -428,6 +434,7 @@ public Definition value(final String value) {
     /**
      * @return Cookie's value.
      */
+    @Nonnull
     public Optional<String> value() {
       if (Strings.isNullOrEmpty(value)) {
         return Optional.empty();
@@ -441,6 +448,7 @@ public Optional<String> value() {
      * @param domain Cookie's domain.
      * @return This definition.
      */
+    @Nonnull
     public Definition domain(final String domain) {
       this.domain = requireNonNull(domain, "A cookie domain is required.");
       return this;
@@ -449,6 +457,7 @@ public Definition domain(final String domain) {
     /**
      * @return A cookie's domain.
      */
+    @Nonnull
     public Optional<String> domain() {
       return Optional.ofNullable(domain);
     }
@@ -459,6 +468,7 @@ public Optional<String> domain() {
      * @param path Cookie's path.
      * @return This definition.
      */
+    @Nonnull
     public Definition path(final String path) {
       this.path = requireNonNull(path, "A cookie path is required.");
       return this;
@@ -467,6 +477,7 @@ public Definition path(final String path) {
     /**
      * @return Get cookie's path.
      */
+    @Nonnull
     public Optional<String> path() {
       return Optional.ofNullable(path);
     }
@@ -477,6 +488,7 @@ public Optional<String> path() {
      * @param comment A cookie's comment.
      * @return This definition.
      */
+    @Nonnull
     public Definition comment(final String comment) {
       this.comment = requireNonNull(comment, "A cookie comment is required.");
       return this;
@@ -485,6 +497,7 @@ public Definition comment(final String comment) {
     /**
      * @return Cookie's comment.
      */
+    @Nonnull
     public Optional<String> comment() {
       return Optional.ofNullable(comment);
     }
@@ -495,6 +508,7 @@ public Optional<String> comment() {
      * @param httpOnly True, for HTTP Only.
      * @return This definition.
      */
+    @Nonnull
     public Definition httpOnly(final boolean httpOnly) {
       this.httpOnly = httpOnly;
       return this;
@@ -503,6 +517,7 @@ public Definition httpOnly(final boolean httpOnly) {
     /**
      * @return HTTP only flag.
      */
+    @Nonnull
     public Optional<Boolean> httpOnly() {
       return Optional.ofNullable(httpOnly);
     }
@@ -513,6 +528,7 @@ public Optional<Boolean> httpOnly() {
      * @param secure True, ensure that the session cookie is only transmitted via HTTPS.
      * @return This definition.
      */
+    @Nonnull
     public Definition secure(final boolean secure) {
       this.secure = secure;
       return this;
@@ -521,6 +537,7 @@ public Definition secure(final boolean secure) {
     /**
      * @return True, ensure that the session cookie is only transmitted via HTTPS.
      */
+    @Nonnull
     public Optional<Boolean> secure() {
       return Optional.ofNullable(secure);
     }
@@ -543,6 +560,7 @@ public Optional<Boolean> secure() {
      * means the cookie is not stored; if zero, deletes the cookie.
      * @return This definition.
      */
+    @Nonnull
     public Definition maxAge(final int maxAge) {
       this.maxAge = maxAge;
       return this;
@@ -564,6 +582,7 @@ public Definition maxAge(final int maxAge) {
      *
      * @return Cookie's max age in seconds.
      */
+    @Nonnull
     public Optional<Integer> maxAge() {
       return Optional.ofNullable(maxAge);
     }
@@ -608,6 +627,7 @@ public class Signature {
      * @param secret A secret key.
      * @return A signed value.
      */
+    @Nonnull
     public static String sign(final String value, final String secret) {
       requireNonNull(value, "A value is required.");
       requireNonNull(secret, "A secret is required.");
@@ -628,8 +648,9 @@ public static String sign(final String value, final String secret) {
      *
      * @param value A signed value.
      * @param secret A secret key.
-     * @return A new signed value.
+     * @return A new signed value or null.
      */
+    @Nullable
     public static String unsign(final String value, final String secret) {
       requireNonNull(value, "A value is required.");
       requireNonNull(secret, "A secret is required.");
@@ -659,21 +680,25 @@ public static boolean valid(final String value, final String secret) {
   /**
    * @return Cookie's name.
    */
+  @Nonnull
   String name();
 
   /**
    * @return Cookie's value.
    */
+  @Nonnull
   Optional<String> value();
 
   /**
    * @return An optional comment.
    */
+  @Nonnull
   Optional<String> comment();
 
   /**
    * @return Cookie's domain.
    */
+  @Nonnull
   Optional<String> domain();
 
   /**
@@ -692,6 +717,7 @@ public static boolean valid(final String value, final String secret) {
   /**
    * @return Cookie's path.
    */
+  @Nonnull
   Optional<String> path();
 
   /**
@@ -710,5 +736,6 @@ public static boolean valid(final String value, final String secret) {
   /**
    * @return Encode the cookie.
    */
+  @Nonnull
   String encode();
 }
diff --git a/jooby/src/main/java/org/jooby/Deferred.java b/jooby/src/main/java/org/jooby/Deferred.java
@@ -205,6 +205,7 @@
 
 import static java.util.Objects.requireNonNull;
 
+import javax.annotation.Nonnull;
 import java.util.Optional;
 import java.util.concurrent.Callable;
 import java.util.concurrent.Executor;
@@ -331,7 +332,7 @@ public class Deferred extends Result {
    * @author edgar
    * @since 0.10.0
    */
-  public static interface Initializer0 {
+  public interface Initializer0 {
 
     /**
      * Run the initializer block.
@@ -348,7 +349,7 @@ public static interface Initializer0 {
    * @author edgar
    * @since 0.10.0
    */
-  public static interface Initializer {
+  public interface Initializer {
 
     /**
      * Run the initializer block.
@@ -366,7 +367,7 @@ public static interface Initializer {
    * @author edgar
    * @since 0.10.0
    */
-  public static interface Handler {
+  public interface Handler {
     void handle(Result result, Throwable exception);
   }
 
@@ -432,6 +433,7 @@ public Deferred() {
    * @param value Resolved value.
    */
   @Override
+  @Nonnull
   public Result set(final Object value) {
     if (value instanceof Throwable) {
       reject((Throwable) value);
@@ -447,6 +449,7 @@ public Result set(final Object value) {
    *
    * @return Executor to use or fallback to global/application executor.
    */
+  @Nonnull
   public Optional<String> executor() {
     return Optional.ofNullable(executor);
   }
@@ -456,6 +459,7 @@ public Optional<String> executor() {
    *
    * @return Name of the caller thread (thread that creates this deferred object).
    */
+  @Nonnull
   public String callerThread() {
     return callerThread;
   }
@@ -466,6 +470,7 @@ public String callerThread() {
    *
    * @param value A value for this deferred.
    */
+  @Nonnull
   public void resolve(final Object value) {
     if (value == null) {
       handler.handle(null, null);
@@ -539,6 +544,7 @@ public void handler(final Request req, final Handler handler) throws Exception {
    * @param handler Application block.
    * @return A new deferred handler.
    */
+  @Nonnull
   public static Deferred deferred(final Route.OneArgHandler handler) {
     return deferred(null, handler);
   }
@@ -574,6 +580,7 @@ public static Deferred deferred(final Route.OneArgHandler handler) {
    * @param handler Application block.
    * @return A new deferred.
    */
+  @Nonnull
   public static Deferred deferred(final Route.ZeroArgHandler handler) {
     return deferred(null, handler);
   }
@@ -599,6 +606,7 @@ public static Deferred deferred(final Route.ZeroArgHandler handler) {
    * @param handler Application block.
    * @return A new deferred handler.
    */
+  @Nonnull
   public static Deferred deferred(final String executor, final Route.ZeroArgHandler handler) {
     return deferred(executor, req -> handler.handle());
   }
@@ -624,6 +632,7 @@ public static Deferred deferred(final String executor, final Route.ZeroArgHandle
    * @param handler Application block.
    * @return A new deferred handler.
    */
+  @Nonnull
   public static Deferred deferred(final String executor, final Route.OneArgHandler handler) {
     return new Deferred(executor, (req, deferred) -> {
       try {