v2.0.0.RC3

Author: jknack

docs/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.jooby</groupId>
     <artifactId>jooby-project</artifactId>
-    <version>2.0.0.RC3-SNAPSHOT</version>
+    <version>2.0.0.RC3</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>

examples/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.jooby</groupId>
     <artifactId>jooby-project</artifactId>
-    <version>2.0.0.RC3-SNAPSHOT</version>
+    <version>2.0.0.RC3</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>

jooby/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.jooby</groupId>
     <artifactId>jooby-project</artifactId>
-    <version>2.0.0.RC3-SNAPSHOT</version>
+    <version>2.0.0.RC3</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>

jooby/src/main/java/io/jooby/Context.java

@@ -119,16 +119,34 @@ public interface Context extends Registry {
    * **********************************************************************************************
    */
 
+  /**
+   * Flash map.
+   *
+   * @return Flash map.
+   */
   default @Nonnull FlashMap flashMap() {
     return (FlashMap) getAttributes()
         .computeIfAbsent(FlashMap.NAME, key -> FlashMap
             .create(this, new Cookie(getRouter().getFlashCookie()).setHttpOnly(true)));
   }
 
+  /**
+   * Get a flash attribute.
+   *
+   * @param name Attribute's name.
+   * @return Flash attribute.
+   */
   default @Nonnull Value flash(@Nonnull String name) {
     return Value.create(name, flashMap().get(name));
   }
 
+  /**
+   * Set a flash attribute.
+   *
+   * @param name Attribute's name.
+   * @param value Attribute's value.
+   * @return This context.
+   */
   default @Nonnull Context flash(@Nonnull String name, @Nonnull String value) {
     flashMap().put(name, value);
     return this;
@@ -941,6 +959,12 @@ default long getRequestLength() {
    */
   @Nonnull Context setResponseHeader(@Nonnull String name, @Nonnull String value);
 
+  /**
+   * Remove a response header.
+   *
+   * @param name Header's name.
+   * @return This context.
+   */
   @Nonnull Context removeResponseHeader(@Nonnull String name);
 
   /**

jooby/src/main/java/io/jooby/Cookie.java

@@ -24,8 +24,6 @@
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
-import static java.util.Objects.requireNonNull;
-
 /**
  * Response cookie implementation. Response are send it back to client using
  * {@link Context#setResponseCookie(Cookie)}.
@@ -402,9 +400,12 @@ public long getMaxAge() {
   /**
    * Encode a hash into cookie value, like: <code>k1=v1&amp;...&amp;kn=vn</code>. Also,
    * <code>key</code> and <code>value</code> are encoded using {@link URLEncoder}.
+   *
+   * @param attributes Map to encode.
+   * @return URL encoded from map attributes.
    */
-  public static String encode(Map<String, String> attributes) {
-    if (attributes.size() == 0) {
+  public static @Nonnull String encode(@Nullable Map<String, String> attributes) {
+    if (attributes == null || attributes.size() == 0) {
       return "";
     }
     try {
@@ -429,8 +430,11 @@ public static String encode(Map<String, String> attributes) {
    * Decode a cookie value using, like: <code>k=v</code>, multiple <code>k=v</code> pair are
    * separated by <code>&amp;</code>. Also, <code>k</code> and <code>v</code> are decoded using
    * {@link URLDecoder}.
+   *
+   * @param value URL encoded value.
+   * @return Decoded as map.
    */
-  public static Map<String, String> decode(String value) {
+  public static @Nonnull Map<String, String> decode(@Nullable String value) {
     if (value == null || value.length() == 0) {
       return Collections.emptyMap();
     }

jooby/src/main/java/io/jooby/Environment.java

@@ -72,13 +72,26 @@ public Environment(@Nonnull ClassLoader classLoader, @Nonnull Config conf, @Nonn
     this.conf = conf;
   }
 
+  /**
+   * Get a property under the given key or use the given default value when missing.
+   *
+   * @param key Property key.
+   * @param defaults Default value.
+   * @return Property or default value.
+   */
   public @Nonnull String getProperty(@Nonnull String key, @Nonnull String defaults) {
     if (conf.hasPath(key)) {
       return conf.getString(key);
     }
     return defaults;
   }
 
+  /**
+   * Get a property under the given key or <code>null</code> when missing.
+   *
+   * @param key Property key.
+   * @return Property value or <code>null</code> when missing.
+   */
   public @Nullable String getProperty(@Nonnull String key) {
     if (conf.hasPath(key)) {
       return conf.getString(key);
@@ -125,6 +138,12 @@ public boolean isActive(@Nonnull String name, String... names) {
     return classLoader;
   }
 
+  /**
+   * Loaded class or empty.
+   *
+   * @param className Class name.
+   * @return Load a class or get an empty value.
+   */
   public @Nonnull Optional<Class> loadClass(@Nonnull String className) {
     try {
       return Optional.of(classLoader.loadClass(className));
@@ -133,10 +152,6 @@ public boolean isActive(@Nonnull String name, String... names) {
     }
   }
 
-  public boolean isClassPresent(String className) {
-    return loadClass(className).isPresent();
-  }
-
   @Override public String toString() {
     return actives + "\n" + toString(conf).trim();
   }

jooby/src/main/java/io/jooby/Extension.java

@@ -18,6 +18,13 @@
  */
 public interface Extension {
 
+  /**
+   * True when extension needs to run while starting the application. Defaults is false, starts
+   * immediately.
+   *
+   * @return True when extension needs to run while starting the application. Defaults is false,
+   *     starts immediately.
+   */
   default boolean lateinit() {
     return false;
   }

jooby/src/main/java/io/jooby/FlashMap.java

@@ -8,34 +8,35 @@
 import io.jooby.internal.FlashMapImpl;
 
 import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import java.util.HashMap;
 import java.util.Map;
 
 /**
- * Flash scope.
+ * Flash map.
  *
  * @author edgar
  * @since 2.0.0
  */
 public interface FlashMap extends Map<String, String> {
 
+  /** Flash map attribute. */
   String NAME = "flash";
 
   /**
    * Creates a new flash-scope using the given cookie.
    *
-   * @param ctx
-   * @param template
-   * @return
+   * @param ctx Web context.
+   * @param template Cookie template.
+   * @return A new flash map.
    */
-  static @Nonnull FlashMap create(Context ctx, Cookie template) {
+  static @Nonnull FlashMap create(@Nonnull Context ctx, @Nonnull Cookie template) {
     return new FlashMapImpl(ctx, template);
   }
 
   /**
    * Keep flash cookie for next request.
+   *
+   * @return This flash map.
    */
-  FlashMap keep();
+  @Nonnull FlashMap keep();
 
 }

jooby/src/main/java/io/jooby/RegistryException.java

@@ -7,11 +7,27 @@
 
 import javax.annotation.Nonnull;
 
+/**
+ * Thrown when a required service is not available.
+ *
+ */
 public class RegistryException extends StatusCodeException {
+
+  /**
+   * Constructor.
+   *
+   * @param message Error message.
+   * @param cause Cause.
+   */
   public RegistryException(@Nonnull String message, Throwable cause) {
     super(StatusCode.SERVER_ERROR, message, cause);
   }
 
+  /**
+   * Constructor.
+   *
+   * @param message Error message.
+   */
   public RegistryException(@Nonnull String message) {
     super(StatusCode.SERVER_ERROR, message);
   }

jooby/src/main/java/io/jooby/Route.java

@@ -148,7 +148,6 @@ public interface After extends Serializable {
      *
      * @param ctx Web context.
      * @param result Response generated by route handler.
-     * @return Response to send.
      * @throws Exception If something goes wrong.
      */
     @Nonnull void apply(@Nonnull Context ctx, Object result) throws Exception;
@@ -253,6 +252,7 @@ public interface Handler extends Serializable {
    * @param returnType Return type.
    * @param handler Route handler.
    * @param before Before pipeline.
+   * @param decorator Decorator.
    * @param after After pipeline.
    * @param renderer Route renderer.
    * @param parsers Route parsers.
@@ -385,14 +385,19 @@ public Route(@Nonnull String method,
   }
 
   /**
-   * After decorator or <code>null</code>.
+   * After filter or <code>null</code>.
    *
-   * @return After decorator or <code>null</code>.
+   * @return After filter or <code>null</code>.
    */
   public @Nullable After getAfter() {
     return after;
   }
 
+  /**
+   * Decorator or <code>null</code>.
+   *
+   * @return Decorator or <code>null</code>.
+   */
   public @Nullable Decorator getDecorator() {
     return decorator;
   }