Package dev.voidframework.web.http.routing

Interface Router

All Known Implementing Classes:
DefaultRouter
public interface Router
Router.

  • Method Details

    • addRoute

      void addRoute(HttpMethod httpMethod, String routeUrl, Class<?> controllerClassType, Method method)
      Adds a new route.
      Parameters:
      httpMethod - The HTTP method (ie: GET)
      routeUrl - The route url
      controllerClassType - The controller class type
      method - The method to call

    • addRoute

      void addRoute(HttpMethod httpMethod, String routeUrl, Class<?> controllerClassType, Method method, String name)
      Adds a new route.
      Parameters:
      httpMethod - The HTTP method (ie: GET)
      routeUrl - The route url
      controllerClassType - The controller class type
      method - The method to call
      name - The route name

    • resolveRoute

      ResolvedRoute resolveRoute(HttpMethod httpMethod, String uri)
      Resolves a route.
      Parameters:
      httpMethod - The HTTP method (ie: GET)
      uri - The URI to parse to resolve route
      Returns:
      The resolved route, otherwise, null

    • reverseRoute

      String reverseRoute(String name)
      Reverses a route to obtains a URL.
      Parameters:
      name - The route name
      Returns:
      A string containing a URL

    • reverseRoute

      String reverseRoute(String name, List<Object> parameterList)
      Reverses a route to obtains a URL.
      Parameters:
      name - The route name
      parameterList - The parameters to use
      Returns:
      A string containing a URL

    • getRoutesAsList

      List<Route> getRoutesAsList()
      Retrieves all registered routes.
      Returns:
      All registered routes as List

    • getRoutesAsMap

      Map<HttpMethod,List<Route>> getRoutesAsMap()
      Retrieves all registered routes.
      Returns:
      All registered routes as Map