router: improve routeSet API

- remove mvc() from router
- make all multiple import of routes a routeSet (unify API)

Author: jknack

jooby/src/main/java/io/jooby/Jooby.java

@@ -469,9 +469,8 @@ public Jooby setTrustProxy(boolean trustProxy) {
   }
 
   @NonNull @Override
-  public Router domain(@NonNull String domain, @NonNull Router subrouter) {
-    this.router.domain(domain, subrouter);
-    return this;
+  public RouteSet domain(@NonNull String domain, @NonNull Router subrouter) {
+    return this.router.domain(domain, subrouter);
   }
 
   @NonNull @Override
@@ -485,31 +484,36 @@ public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Runnable b
   }
 
   @NonNull @Override
-  public Jooby mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
-    this.router.mount(predicate, subrouter);
-    return this;
+  public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
+    return this.router.mount(predicate, subrouter);
   }
 
   @NonNull @Override
-  public Jooby mount(@NonNull String path, @NonNull Router router) {
-    this.router.mount(path, router);
+  public RouteSet mount(@NonNull String path, @NonNull Router router) {
+    var rs = this.router.mount(path, router);
     if (router instanceof Jooby) {
       Jooby child = (Jooby) router;
       child.registry = this.registry;
     }
-    return this;
+    return rs;
   }
 
   @NonNull @Override
-  public Jooby mount(@NonNull Router router) {
+  public RouteSet mount(@NonNull Router router) {
     return mount("/", router);
   }
 
-  @NonNull @Override
-  public Jooby mvc(@NonNull Extension router) {
+  /**
+   * Add controller routes.
+   *
+   * @param router Mvc extension.
+   * @return Route set.
+   */
+  @NonNull public RouteSet mvc(@NonNull Extension router) {
     try {
+      int start = this.router.getRoutes().size();
       router.install(this);
-      return this;
+      return new RouteSet(this.router.getRoutes().subList(start, this.router.getRoutes().size()));
     } catch (Exception cause) {
       throw SneakyThrows.propagate(cause);
     }

jooby/src/main/java/io/jooby/RouteSet.java

@@ -9,6 +9,8 @@
 
 import java.util.*;
 import java.util.concurrent.Executor;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -20,7 +22,7 @@
  * @author edgar
  * @since 2.7.3
  */
-public class RouteSet {
+public class RouteSet implements Iterable<Route> {
 
   private List<Route> routes;
 
@@ -30,6 +32,10 @@ public class RouteSet {
 
   private String description;
 
+  public RouteSet(List<Route> routes) {
+    this.routes = routes;
+  }
+
   /**
    * Sub-routes. Always empty except when used it from {@link Router#path(String, Runnable)} or
    * {@link Router#routes(Runnable)}.
@@ -233,4 +239,13 @@ public class RouteSet {
   public @NonNull RouteSet description(@Nullable String description) {
     return setDescription(description);
   }
+
+  public void forEach(Predicate<Route> predicate, Consumer<? super Route> action) {
+    routes.stream().filter(predicate).forEach(action);
+  }
+
+  @Override
+  public Iterator<Route> iterator() {
+    return routes.iterator();
+  }
 }

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

@@ -312,9 +312,9 @@ default Object execute(@NonNull Context context) {
    *
    * @param domain Predicate
    * @param subrouter Subrouter.
-   * @return This router.
+   * @return Created routes.
    */
-  @NonNull Router domain(@NonNull String domain, @NonNull Router subrouter);
+  @NonNull RouteSet domain(@NonNull String domain, @NonNull Router subrouter);
 
   /**
    * Enabled routes for specific domain. Domain matching is done using the <code>host</code> header.
@@ -334,7 +334,7 @@ default Object execute(@NonNull Context context) {
    *
    * @param domain Predicate
    * @param body Route action.
-   * @return This router.
+   * @return Created routes.
    */
   @NonNull RouteSet domain(@NonNull String domain, @NonNull Runnable body);
 
@@ -360,9 +360,9 @@ default Object execute(@NonNull Context context) {
    *
    * @param predicate Context predicate.
    * @param router Router to import.
-   * @return This router.
+   * @return Created routes.
    */
-  @NonNull Router mount(@NonNull Predicate<Context> predicate, @NonNull Router router);
+  @NonNull RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Router router);
 
   /**
    * Import routes from given action. Predicate works like a filter and only when predicate pass the
@@ -387,7 +387,7 @@ default Object execute(@NonNull Context context) {
    *
    * @param predicate Context predicate.
    * @param body Route action.
-   * @return This router.
+   * @return Created routes.
    */
   @NonNull RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Runnable body);
 
@@ -398,33 +398,25 @@ default Object execute(@NonNull Context context) {
    *
    * @param path Prefix path.
    * @param router Router to import.
-   * @return This router.
+   * @return Created routes.
    */
-  @NonNull Router mount(@NonNull String path, @NonNull Router router);
+  @NonNull RouteSet mount(@NonNull String path, @NonNull Router router);
 
   /**
    * Import all routes from the given router.
    *
    * <p>NOTE: ONLY routes are imported. Services, callback, etc.. are ignored.
    *
    * @param router Router to import.
-   * @return This router.
+   * @return Created routes.
    */
-  @NonNull Router mount(@NonNull Router router);
+  @NonNull RouteSet mount(@NonNull Router router);
 
   /* ***********************************************************************************************
    * Mvc
    * ***********************************************************************************************
    */
 
-  /**
-   * Import all routes from the given controller class.
-   *
-   * @param router Router extension.
-   * @return This router.
-   */
-  @NonNull Router mvc(@NonNull Extension router);
-
   /**
    * Add a websocket handler.
    *

jooby/src/main/java/io/jooby/internal/RouterImpl.java

@@ -136,7 +136,7 @@ public Stack executor(Executor executor) {
 
   private List<Route> routes = new ArrayList<>();
 
-  private HttpMessageEncoder encoder = new HttpMessageEncoder();
+  private final HttpMessageEncoder encoder = new HttpMessageEncoder();
 
   private String basePath;
 
@@ -265,19 +265,17 @@ public RouteSet domain(@NonNull String domain, @NonNull Runnable body) {
   }
 
   @NonNull @Override
-  public Router domain(@NonNull String domain, @NonNull Router subrouter) {
+  public RouteSet domain(@NonNull String domain, @NonNull Router subrouter) {
     return mount(domainPredicate(domain), subrouter);
   }
 
   @NonNull @Override
   public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Runnable body) {
-    var routeSet = new RouteSet();
     var tree = new Chi();
     putPredicate(predicate, tree);
     int start = this.routes.size();
     newStack(tree, "/", body);
-    routeSet.setRoutes(this.routes.subList(start, this.routes.size()));
-    return routeSet;
+    return new RouteSet(this.routes.subList(start, this.routes.size()));
   }
 
   public Router install(
@@ -297,42 +295,37 @@ public Router install(
   }
 
   @NonNull @Override
-  public Router mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
-    /** Override services: */
+  public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
+    /* Override services: */
     overrideAll(this, subrouter);
-    /** Routes: */
-    mount(
+    /* Routes: */
+    return mount(
         predicate,
         () -> {
           for (Route route : subrouter.getRoutes()) {
             Route newRoute = newRoute(route.getMethod(), route.getPattern(), route.getHandler());
             copy(route, newRoute);
           }
         });
-    return this;
   }
 
   @NonNull @Override
-  public Router mount(@NonNull String path, @NonNull Router router) {
+  public RouteSet mount(@NonNull String path, @NonNull Router router) {
+    int start = this.routes.size();
     /** Override services: */
     overrideAll(this, router);
     /** Merge error handler: */
     mergeErrorHandler(router);
     /** Routes: */
     copyRoutes(path, router);
-    return this;
+    return new RouteSet(this.routes.subList(start, this.routes.size()));
   }
 
   @NonNull @Override
-  public Router mount(@NonNull Router router) {
+  public RouteSet mount(@NonNull Router router) {
     return mount("/", router);
   }
 
-  @NonNull @Override
-  public Router mvc(@NonNull Extension router) {
-    throw new UnsupportedOperationException();
-  }
-
   @NonNull @Override
   public Router encoder(@NonNull MessageEncoder encoder) {
     this.encoder.add(MediaType.all, encoder);
@@ -413,11 +406,9 @@ public RouteSet routes(@NonNull Runnable action) {
 
   @Override
   @NonNull public RouteSet path(@NonNull String pattern, @NonNull Runnable action) {
-    RouteSet routeSet = new RouteSet();
     int start = this.routes.size();
     newStack(chi, pattern, action);
-    routeSet.setRoutes(this.routes.subList(start, this.routes.size()));
-    return routeSet;
+    return new RouteSet(this.routes.subList(start, this.routes.size()));
   }
 
   @NonNull @Override
@@ -898,7 +889,6 @@ private void copy(Route src, Route it) {
     it.setFilter(filter);
     it.setAfter(after);
     it.setEncoder(src.getEncoder());
-    // it.setReturnType(src.getReturnType());
     it.setHandle(src.getHandle());
     it.setProduces(src.getProduces());
     it.setConsumes(src.getConsumes());