Package com.duncpro.jroute.router

Interface Router<E>

All Known Implementing Classes:

DelegatingRouter, RestRouter, TreeRouter

public interface Router<E>

Method Summary

Modifier and Type	Method	Description
void	add(Route route, E endpoint)
default void	add(PositionedEndpoint<E> positionedEndpoint)
default void	add(java.lang.String routeString, E endpoint)
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)
default java.util.Optional<RouteMatch<E>>	route(java.lang.String pathString)

Method Detail

route

default java.util.Optional<RouteMatch<E>> route(java.lang.String pathString)

route

java.util.Optional<RouteMatch<E>> route(Path path)

add

default void add(java.lang.String routeString,
                 E endpoint)
          throws RouteConflictException

Throws:

RouteConflictException

add

void add(Route route,
         E endpoint)
  throws RouteConflictException

Throws:

RouteConflictException

getOrAdd

E getOrAdd(Route route,
           java.util.function.Supplier<E> endpointFactory)

getAllEndpoints

java.util.Set<PositionedEndpoint<E>> getAllEndpoints(Route prefix)

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.

getEndpoint

java.util.Optional<E> getEndpoint(Route at)

Returns the endpoint which exists at the given Route (if any).

add

default void add(PositionedEndpoint<E> positionedEndpoint)

Throws:

RouteConflictException - if the given endpoint conflicts with a pre-existing endpoint within the router.