javadoc+checkstyle fixes

Author: jknack

jooby/src/main/java/io/jooby/Cors.java

@@ -7,6 +7,7 @@
 
 import com.typesafe.config.Config;
 
+import javax.annotation.Nonnull;
 import java.time.Duration;
 import java.util.Arrays;
 import java.util.Collections;
@@ -55,7 +56,7 @@ private static class Matcher<T> implements Predicate<T> {
 
     private boolean wild;
 
-    public Matcher(final List<String> values, final Predicate<T> predicate) {
+    Matcher(final List<String> values, final Predicate<T> predicate) {
       this.values = values;
       this.predicate = predicate;
       this.wild = values.contains("*");
@@ -71,6 +72,9 @@ public boolean test(final T value) {
     }
   }
 
+  /** Default max-age in minutes. */
+  private static final int _30 = 30;
+
   private Matcher<String> origin;
 
   private boolean credentials;
@@ -100,7 +104,7 @@ public Cors() {
     setUseCredentials(true);
     setMethods("GET", "POST");
     setHeaders("X-Requested-With", "Content-Type", "Accept", "Origin");
-    setMaxAge(Duration.ofMinutes(30));
+    setMaxAge(Duration.ofMinutes(_30));
   }
 
   /**
@@ -112,6 +116,12 @@ public boolean getUseCredentials() {
     return this.credentials;
   }
 
+  /**
+   * If true, set the <code>Access-Control-Allow-Credentials</code> header.
+   *
+   * @param credentials Credentials.
+   * @return This cors.
+   */
   public Cors setUseCredentials(boolean credentials) {
     this.credentials = credentials;
     return this;
@@ -310,7 +320,23 @@ public Cors setMaxAge(final Duration preflightMaxAge) {
     return this;
   }
 
-  public static Cors from(Config conf) {
+  /**
+   * Get cors options from application configuration file.
+   *
+   * <pre>{@code
+   * cors {
+   *   origin: *
+   *   methods: [GET, POST]
+   *   headers: [Custom-Header]
+   *   maxAge: 30m
+   *   exposesHeaders: [Header]
+   * }
+   * }</pre>
+   *
+   * @param conf Configuration.
+   * @return Cors options.
+   */
+  public static @Nonnull Cors from(@Nonnull Config conf) {
     Config cors = conf.hasPath("cors") ? conf.getConfig("cors") : conf;
     Cors options = new Cors();
     if (cors.hasPath("origin")) {

jooby/src/main/java/io/jooby/CorsHandler.java

@@ -52,6 +52,9 @@ public CorsHandler(@Nonnull final Cors options) {
     this.options = options;
   }
 
+  /**
+   * Creates a new {@link CorsHandler} with default options.
+   */
   public CorsHandler() {
     this(new Cors());
   }

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

@@ -22,7 +22,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.StringJoiner;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 

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

@@ -648,14 +648,30 @@ public Route(@Nonnull String method, @Nonnull String pattern, @Nonnull Handler h
     return this;
   }
 
+  /**
+   * True if route support HTTP OPTIONS.
+   *
+   * @return True if route support HTTP OPTIONS.
+   */
   public boolean isHttpOptions() {
     return supportedMethod != null && supportedMethod.contains(Router.OPTIONS);
   }
 
+  /**
+   * True if route support HTTP TRACE.
+   *
+   * @return True if route support HTTP TRACE.
+   */
   public boolean isHttpTrace() {
     return supportedMethod != null && supportedMethod.contains(Router.TRACE);
   }
 
+  /**
+   * Enabled or disabled HTTP Options.
+   *
+   * @param enabled Enabled or disabled HTTP Options.
+   * @return  This route.
+   */
   public @Nonnull Route setHttpOptions(boolean enabled) {
     if (supportedMethod == null) {
       supportedMethod = new HashSet<>();
@@ -668,6 +684,12 @@ public boolean isHttpTrace() {
     return this;
   }
 
+  /**
+   * Enabled or disabled HTTP TRACE.
+   *
+   * @param enabled Enabled or disabled HTTP TRACE.
+   * @return  This route.
+   */
   public @Nonnull Route setHttpTrace(boolean enabled) {
     if (supportedMethod == null) {
       supportedMethod = new HashSet<>();

jooby/src/main/java/io/jooby/Router.java

@@ -8,7 +8,6 @@
 import org.slf4j.Logger;
 
 import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
 import javax.inject.Provider;
 import java.nio.file.Files;
 import java.nio.file.Path;

jooby/src/main/java/io/jooby/TraceHandler.java

@@ -10,12 +10,19 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
+/**
+ * The TRACE method performs a message loop-back test along the path to the target resource.
+ *
+ * @author
+ * @since 2.0.4
+ */
 public class TraceHandler implements Route.Decorator {
+  private static final String CRLF = "\r\n";
+
   @Nonnull @Override public Route.Handler apply(@Nonnull Route.Handler next) {
     return ctx -> {
       if (ctx.getMethod().equals(Router.TRACE)) {
         // Handle trace
-        String CRLF = "\r\n";
         StringBuilder buffer = new StringBuilder(Router.TRACE).append(" ").append(ctx.pathString())
             .append(" ").append(ctx.getProtocol());
 

modules/jooby-netty/src/main/java/io/jooby/netty/Netty.java

@@ -41,6 +41,10 @@ public class Netty extends Server.Base {
         System.getProperty("io.netty.leakDetection.level", "disabled"));
   }
 
+  private static final int _50 = 50;
+
+  private static final int _100 = 100;
+
   private List<Jooby> applications = new ArrayList<>();
 
   private EventLoopGroup acceptorloop;
@@ -82,10 +86,10 @@ public class Netty extends Server.Base {
       NettyTransport transport = NettyTransport.transport(application.getClassLoader());
 
       /** Acceptor event-loop */
-      this.acceptorloop = transport.createEventLoop(1, "acceptor", 50);
+      this.acceptorloop = transport.createEventLoop(1, "acceptor", _50);
 
       /** Event loop: processing connections, parsing messages and doing engine's internal work */
-      this.eventloop = transport.createEventLoop(options.getIoThreads(), "eventloop", 100);
+      this.eventloop = transport.createEventLoop(options.getIoThreads(), "eventloop", _100);
 
       /** File data factory: */
       HttpDataFactory factory = new DefaultHttpDataFactory(options.getBufferSize());

modules/jooby-test/src/main/java/io/jooby/MockContext.java

@@ -232,6 +232,12 @@ public MockContext setPathString(@Nonnull String pathString) {
     return files;
   }
 
+  /**
+   * Set mock files.
+   *
+   * @param files Mock files.
+   * @return This context.
+   */
   public MockContext setFiles(@Nonnull List<FileUpload> files) {
     this.files = files;
     return this;