Package com.duncpro.jroute.router

Class TreeRouter<E>

  • All Implemented Interfaces:
    Router<E>
    @NotThreadSafe
public class TreeRouter<E>
extends java.lang.Object
implements Router<E>

    • Constructor Summary

      Constructors 
      Constructor Description
      TreeRouter()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(Route route, E endpoint)  
      protected static <E> java.util.Optional<com.duncpro.jroute.router.RouteTreeNode<E>> findNode​(com.duncpro.jroute.router.RouteTreeNode<E> routeTree, Path path)
      Finds the RouteTreeNode which is responsible for handling requests made on the given Path.
      protected static <E> com.duncpro.jroute.router.RouteTreeNode<E> findOrCreateNode​(com.duncpro.jroute.router.RouteTreeNode<E> routeTree, Route route)
      A variant of findNode(RouteTreeNode, Path) which will add new branches to the route tree if necessary so that the Route may be resolved to a RouteTreeNode.
      java.util.Set<PositionedEndpoint<E>> getAllEndpoints​(Route prefix)
      Returns a set of PositionedEndpoints which are accessible via the given Route.
      java.util.Optional<E> getEndpoint​(Route at)
      Returns the endpoint which exists at the given Route (if any).
      E getOrAdd​(Route route, java.util.function.Supplier<E> endpointFactory)  
      java.util.Optional<RouteMatch<E>> route​(Path path)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TreeRouter

        public TreeRouter()

    • Method Detail

      • getOrAdd

        public E getOrAdd​(Route route,
                  java.util.function.Supplier<E> endpointFactory)
        Specified by:
        getOrAdd in interface Router<E>

      • getAllEndpoints

        public java.util.Set<PositionedEndpoint<E>> getAllEndpoints​(Route prefix)
        Description copied from interface: Router
        Returns a set of PositionedEndpoints which are accessible via the given Route. The returned collection includes the endpoints defined on the given Route as well as all endpoints which exists on routes that descend from the given Route.
        Specified by:
        getAllEndpoints in interface Router<E>

      • getEndpoint

        public java.util.Optional<E> getEndpoint​(Route at)
        Description copied from interface: Router
        Returns the endpoint which exists at the given Route (if any).
        Specified by:
        getEndpoint in interface Router<E>

      • findNode

        protected static <E> java.util.Optional<com.duncpro.jroute.router.RouteTreeNode<E>> findNode​(com.duncpro.jroute.router.RouteTreeNode<E> routeTree,
                                                                                             Path path)
        Finds the RouteTreeNode which is responsible for handling requests made on the given Path. If no RouteTreeNode has been delegated for this path, any empty optional is returned instead.

      • findOrCreateNode

        protected static <E> com.duncpro.jroute.router.RouteTreeNode<E> findOrCreateNode​(com.duncpro.jroute.router.RouteTreeNode<E> routeTree,
                                                                                 Route route)
        A variant of findNode(RouteTreeNode, Path) which will add new branches to the route tree if necessary so that the Route may be resolved to a RouteTreeNode. If no nodes need to be added then this function is analogous to the aforementioned one. Finally this function returns the RouteTreeNode corresponding to the last RouteElement in the Route.