org.springframework.web.reactive.function

Interface RouterFunction<T>

Type Parameters:

T - the type of the handler function to route to

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RouterFunction<T>

Represents a function that routes to a handler function.

Since:

5.0

Author:

Arjen Poutsma

See Also:

RouterFunctions

Method Summary

Modifier and Type	Method and Description
default RouterFunction<?>	and(RouterFunction<?> other) Return a composed routing function that first invokes this function, and then invokes the other function (of a different type) if this route had no result.
default RouterFunction<T>	andSame(RouterFunction<T> other) Return a composed routing function that first invokes this function, and then invokes the other function (of the same type T) if this route had no result.
default <S> RouterFunction<S>	filter(FilterFunction<T,S> filterFunction) Filter all handler functions routed by this function with the given filter function.
Optional<HandlerFunction<T>>	route(Request request) Return the handler function that matches the given request.

Method Detail

route

Optional<HandlerFunction<T>> route(Request request)

Return the handler function that matches the given request.

Parameters:

request - the request to route to

Returns:

an Optional describing the HandlerFunction that matches this request, or an empty Optional if there is no match

andSame

default RouterFunction<T> andSame(RouterFunction<T> other)

Return a composed routing function that first invokes this function, and then invokes the other function (of the same type T) if this route had no result.

Parameters:

other - the function of type T to apply when this function has no result

Returns:

a composed function that first routes with this function and then the other function if this function has no result

and

default RouterFunction<?> and(RouterFunction<?> other)

Return a composed routing function that first invokes this function, and then invokes the other function (of a different type) if this route had no result.

Parameters:

other - the function to apply when this function has no result

Returns:

a composed function that first routes with this function and then the other function if this function has no result

filter

default <S> RouterFunction<S> filter(FilterFunction<T,S> filterFunction)

Filter all handler functions routed by this function with the given filter function.

Type Parameters:

S - the filter return type

Parameters:

filterFunction - the filter to apply

Returns:

the filtered routing function