/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.reactivex.ext.web;

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import java.util.List;
import io.vertx.core.http.HttpMethod;
import io.vertx.core.Handler;

A router receives request from an HttpServer and routes it to the first matching Route that it contains. A router can contain many routes. 

Routers are also used for routing failures.
 NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen. /**
 * A router receives request from an {@link io.vertx.reactivex.core.http.HttpServer} and routes it to the first matching
 * {@link io.vertx.reactivex.ext.web.Route} that it contains. A router can contain many routes.
 * <p>
 * Routers are also used for routing failures.
 *
 * <p/>
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.Router original} non RX-ified interface using Vert.x codegen.
 */

@io.vertx.lang.rx.RxGen(io.vertx.ext.web.Router.class)
public class Router implements io.vertx.core.Handler<io.vertx.reactivex.core.http.HttpServerRequest> {

  @Override
  public String toString() {
    return delegate.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Router that = (Router) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final io.vertx.lang.rx.TypeArg<Router> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>(    obj -> new Router((io.vertx.ext.web.Router) obj),
    Router::getDelegate
  );

  private final io.vertx.ext.web.Router delegate;
  
  public Router(io.vertx.ext.web.Router delegate) {
    this.delegate = delegate;
  }

  public io.vertx.ext.web.Router getDelegate() {
    return delegate;
  }

  
Something has happened, so handle it.
Params:
event – the event to handle/**
   * Something has happened, so handle it.
   * @param event the event to handle
   */
  public void handle(io.vertx.reactivex.core.http.HttpServerRequest event) { 
    delegate.handle(event.getDelegate());
  }

  
Create a router
Params:
vertx – the Vert.x instance
Returns:
the router/**
   * Create a router
   * @param vertx the Vert.x instance
   * @return the router
   */
  public static io.vertx.reactivex.ext.web.Router router(io.vertx.reactivex.core.Vertx vertx) { 
    io.vertx.reactivex.ext.web.Router ret = io.vertx.reactivex.ext.web.Router.newInstance(io.vertx.ext.web.Router.router(vertx.getDelegate()));
    return ret;
  }

  
This method is used to provide a request to the router. Usually you take request from the HttpServer.requestHandler and pass it to this method. The router then routes it to matching routes. This method is now deprecated you can use this object directly as a request handler, which means there is no need for a method reference anymore. 
Params:
request – the request/**
   * This method is used to provide a request to the router. Usually you take request from the
   * {@link io.vertx.reactivex.core.http.HttpServer#requestHandler} and pass it to this method. The
   * router then routes it to matching routes.
   *
   * This method is now deprecated you can use this object directly as a request handler, which
   * means there is no need for a method reference anymore.
   * @param request the request
   */
  @Deprecated()
  public void accept(io.vertx.reactivex.core.http.HttpServerRequest request) { 
    delegate.accept(request.getDelegate());
  }

  
Add a route with no matching criteria, i.e. it matches all requests or failures.
Returns:
the route/**
   * Add a route with no matching criteria, i.e. it matches all requests or failures.
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route route() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.route());
    return ret;
  }

  
Add a route that matches the specified HTTP method and path
Params:
method – the HTTP method to match
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches the specified HTTP method and path
   * @param method the HTTP method to match
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route route(HttpMethod method, String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.route(method, path));
    return ret;
  }

  
Add a route that matches the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route route(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.route(path));
    return ret;
  }

  
Add a route that matches the specified HTTP method and path regex
Params:
method – the HTTP method to match
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches the specified HTTP method and path regex
   * @param method the HTTP method to match
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route routeWithRegex(HttpMethod method, String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.routeWithRegex(method, regex));
    return ret;
  }

  
Add a route that matches the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route routeWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.routeWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP GET request
Returns:
the route/**
   * Add a route that matches any HTTP GET request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route get() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.get());
    return ret;
  }

  
Add a route that matches a HTTP GET request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP GET request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route get(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.get(path));
    return ret;
  }

  
Add a route that matches a HTTP GET request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP GET request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route getWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.getWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP HEAD request
Returns:
the route/**
   * Add a route that matches any HTTP HEAD request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route head() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.head());
    return ret;
  }

  
Add a route that matches a HTTP HEAD request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP HEAD request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route head(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.head(path));
    return ret;
  }

  
Add a route that matches a HTTP HEAD request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP HEAD request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route headWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.headWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP OPTIONS request
Returns:
the route/**
   * Add a route that matches any HTTP OPTIONS request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route options() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.options());
    return ret;
  }

  
Add a route that matches a HTTP OPTIONS request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP OPTIONS request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route options(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.options(path));
    return ret;
  }

  
Add a route that matches a HTTP OPTIONS request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP OPTIONS request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route optionsWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.optionsWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP PUT request
Returns:
the route/**
   * Add a route that matches any HTTP PUT request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route put() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.put());
    return ret;
  }

  
Add a route that matches a HTTP PUT request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP PUT request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route put(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.put(path));
    return ret;
  }

  
Add a route that matches a HTTP PUT request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP PUT request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route putWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.putWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP POST request
Returns:
the route/**
   * Add a route that matches any HTTP POST request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route post() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.post());
    return ret;
  }

  
Add a route that matches a HTTP POST request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP POST request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route post(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.post(path));
    return ret;
  }

  
Add a route that matches a HTTP POST request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP POST request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route postWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.postWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP DELETE request
Returns:
the route/**
   * Add a route that matches any HTTP DELETE request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route delete() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.delete());
    return ret;
  }

  
Add a route that matches a HTTP DELETE request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP DELETE request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route delete(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.delete(path));
    return ret;
  }

  
Add a route that matches a HTTP DELETE request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP DELETE request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route deleteWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.deleteWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP TRACE request
Returns:
the route/**
   * Add a route that matches any HTTP TRACE request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route trace() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.trace());
    return ret;
  }

  
Add a route that matches a HTTP TRACE request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP TRACE request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route trace(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.trace(path));
    return ret;
  }

  
Add a route that matches a HTTP TRACE request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP TRACE request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route traceWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.traceWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP CONNECT request
Returns:
the route/**
   * Add a route that matches any HTTP CONNECT request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route connect() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.connect());
    return ret;
  }

  
Add a route that matches a HTTP CONNECT request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP CONNECT request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route connect(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.connect(path));
    return ret;
  }

  
Add a route that matches a HTTP CONNECT request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP CONNECT request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route connectWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.connectWithRegex(regex));
    return ret;
  }

  
Add a route that matches any HTTP PATCH request
Returns:
the route/**
   * Add a route that matches any HTTP PATCH request
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route patch() { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.patch());
    return ret;
  }

  
Add a route that matches a HTTP PATCH request and the specified path
Params:
path – URI paths that begin with this path will match
Returns:
the route/**
   * Add a route that matches a HTTP PATCH request and the specified path
   * @param path URI paths that begin with this path will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route patch(String path) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.patch(path));
    return ret;
  }

  
Add a route that matches a HTTP PATCH request and the specified path regex
Params:
regex – URI paths that begin with a match for this regex will match
Returns:
the route/**
   * Add a route that matches a HTTP PATCH request and the specified path regex
   * @param regex URI paths that begin with a match for this regex will match
   * @return the route
   */
  public io.vertx.reactivex.ext.web.Route patchWithRegex(String regex) { 
    io.vertx.reactivex.ext.web.Route ret = io.vertx.reactivex.ext.web.Route.newInstance(delegate.patchWithRegex(regex));
    return ret;
  }

  
Returns:
a list of all the routes on this router/**
   * @return a list of all the routes on this router
   */
  public List<io.vertx.reactivex.ext.web.Route> getRoutes() { 
    List<io.vertx.reactivex.ext.web.Route> ret = delegate.getRoutes().stream().map(elt -> io.vertx.reactivex.ext.web.Route.newInstance(elt)).collect(java.util.stream.Collectors.toList());
    return ret;
  }

  
Remove all the routes from this router
Returns:
a reference to this, so the API can be used fluently/**
   * Remove all the routes from this router
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.Router clear() { 
    delegate.clear();
    return this;
  }

  
Mount a sub router on this router
Params:
mountPoint – the mount point (path prefix) to mount it on
subRouter – the router to mount as a sub router
Returns:
a reference to this, so the API can be used fluently/**
   * Mount a sub router on this router
   * @param mountPoint the mount point (path prefix) to mount it on
   * @param subRouter the router to mount as a sub router
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.Router mountSubRouter(String mountPoint, io.vertx.reactivex.ext.web.Router subRouter) { 
    delegate.mountSubRouter(mountPoint, subRouter.getDelegate());
    return this;
  }

  
Specify a handler for any unhandled exceptions on this router. The handler will be called for exceptions thrown
from handlers. This does not affect the normal failure routing logic.
Params:
exceptionHandler – the exception handler
Returns:
a reference to this, so the API can be used fluently/**
   * Specify a handler for any unhandled exceptions on this router. The handler will be called for exceptions thrown
   * from handlers. This does not affect the normal failure routing logic.
   * @param exceptionHandler the exception handler
   * @return a reference to this, so the API can be used fluently
   */
  @Deprecated()
  public io.vertx.reactivex.ext.web.Router exceptionHandler(Handler<Throwable> exceptionHandler) { 
    delegate.exceptionHandler(exceptionHandler);
    return this;
  }

  
Specify an handler to handle an error for a particular status code. You can use to manage general errors too using status code 500.
The handler will be called when the context fails and other failure handlers didn't write the reply or when an exception is thrown inside an handler.
You must not use RoutingContext.next inside the error handler This does not affect the normal failure routing logic. 
Params:
statusCode – status code the errorHandler is capable of handle
errorHandler – error handler. Note: You must not use RoutingContext.next inside the provided handler
Returns:
a reference to this, so the API can be used fluently/**
   * Specify an handler to handle an error for a particular status code. You can use to manage general errors too using status code 500.
   * The handler will be called when the context fails and other failure handlers didn't write the reply or when an exception is thrown inside an handler.
   * You <b>must not</b> use {@link io.vertx.reactivex.ext.web.RoutingContext#next} inside the error handler
   * This does not affect the normal failure routing logic.
   * @param statusCode status code the errorHandler is capable of handle
   * @param errorHandler error handler. Note: You <b>must not</b> use {@link io.vertx.reactivex.ext.web.RoutingContext#next} inside the provided handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.Router errorHandler(int statusCode, Handler<io.vertx.reactivex.ext.web.RoutingContext> errorHandler) { 
    io.vertx.reactivex.ext.web.Router ret = io.vertx.reactivex.ext.web.Router.newInstance(delegate.errorHandler(statusCode, new Handler<io.vertx.ext.web.RoutingContext>() {
      public void handle(io.vertx.ext.web.RoutingContext event) {
        errorHandler.handle(io.vertx.reactivex.ext.web.RoutingContext.newInstance(event));
      }
    }));
    return ret;
  }

  
Used to route a context to the router. Used for sub-routers. You wouldn't normally call this method directly.
Params:
context – the routing context/**
   * Used to route a context to the router. Used for sub-routers. You wouldn't normally call this method directly.
   * @param context the routing context
   */
  public void handleContext(io.vertx.reactivex.ext.web.RoutingContext context) { 
    delegate.handleContext(context.getDelegate());
  }

  
Used to route a failure to the router. Used for sub-routers. You wouldn't normally call this method directly.
Params:
context – the routing context/**
   * Used to route a failure to the router. Used for sub-routers. You wouldn't normally call this method directly.
   * @param context the routing context
   */
  public void handleFailure(io.vertx.reactivex.ext.web.RoutingContext context) { 
    delegate.handleFailure(context.getDelegate());
  }


  public static  Router newInstance(io.vertx.ext.web.Router arg) {
    return arg != null ? new Router(arg) : null;
  }
}