org.springframework.web.reactive.function.server

Class ToStringVisitor

java.lang.Object

org.springframework.web.reactive.function.server.ToStringVisitor

All Implemented Interfaces:

RequestPredicates.Visitor, RouterFunctions.Visitor

class ToStringVisitor
extends java.lang.Object
implements RouterFunctions.Visitor, RequestPredicates.Visitor

Implementation of RouterFunctions.Visitor that creates a formatted string representation of router functions.

Since:

5.0

Author:

Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.StringBuilder	builder
private int	indent

Constructor Summary

Constructors

Constructor and Description
ToStringVisitor()

Method Summary

Modifier and Type	Method and Description
void	and() Receive "middle" notification of a logical AND predicate.
void	endAnd() Receive last notification of a logical AND predicate.
void	endNegate() Receive last notification of a negated predicate.
void	endNested(RequestPredicate predicate) Receive notification of the end of a nested router function.
void	endOr() Receive last notification of a logical OR predicate.
void	header(java.lang.String name, java.lang.String value) Receive notification of a HTTP header predicate.
private void	indent()
void	method(java.util.Set<HttpMethod> methods) Receive notification of an HTTP method predicate.
void	or() Receive "middle" notification of a logical OR predicate.
void	path(java.lang.String pattern) Receive notification of an path predicate.
void	pathExtension(java.lang.String extension) Receive notification of an path extension predicate.
void	queryParam(java.lang.String name, java.lang.String value) Receive notification of a query parameter predicate.
void	resources(java.util.function.Function<ServerRequest,<any>> lookupFunction) Receive notification of a resource router function.
void	route(RequestPredicate predicate, HandlerFunction<?> handlerFunction) Receive notification of a standard predicated route to a handler function.
void	startAnd() Receive first notification of a logical AND predicate.
void	startNegate() Receive first notification of a negated predicate.
void	startNested(RequestPredicate predicate) Receive notification of the beginning of a nested router function.
void	startOr() Receive first notification of a logical OR predicate.
java.lang.String	toString()
void	unknown(RequestPredicate predicate) Receive first notification of an unknown predicate.
void	unknown(RouterFunction<?> routerFunction) Receive notification of an unknown router function.

Methods inherited from class java.lang.Object

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

Field Detail

builder

private final java.lang.StringBuilder builder

indent

private int indent

Constructor Detail

ToStringVisitor

ToStringVisitor()

Method Detail

startNested

public void startNested(RequestPredicate predicate)

Description copied from interface: RouterFunctions.Visitor

Receive notification of the beginning of a nested router function.

Specified by:

startNested in interface RouterFunctions.Visitor

Parameters:

predicate - the predicate that applies to the nested router functions

See Also:

RouterFunctions.nest(RequestPredicate, RouterFunction)

endNested

public void endNested(RequestPredicate predicate)

Description copied from interface: RouterFunctions.Visitor

Receive notification of the end of a nested router function.

Specified by:

endNested in interface RouterFunctions.Visitor

Parameters:

predicate - the predicate that applies to the nested router functions

See Also:

RouterFunctions.nest(RequestPredicate, RouterFunction)

route

public void route(RequestPredicate predicate,
                  HandlerFunction<?> handlerFunction)

Description copied from interface: RouterFunctions.Visitor

Receive notification of a standard predicated route to a handler function.

Specified by:

route in interface RouterFunctions.Visitor

Parameters:

predicate - the predicate that applies to the handler function

handlerFunction - the handler function.

See Also:

RouterFunctions.route(RequestPredicate, HandlerFunction)

resources

public void resources(java.util.function.Function<ServerRequest,<any>> lookupFunction)

Description copied from interface: RouterFunctions.Visitor

Receive notification of a resource router function.

Specified by:

resources in interface RouterFunctions.Visitor

Parameters:

lookupFunction - the lookup function for the resources

See Also:

RouterFunctions.resources(Function)

unknown

public void unknown(RouterFunction<?> routerFunction)

Description copied from interface: RouterFunctions.Visitor

Receive notification of an unknown router function. This method is called for router functions that were not created via the various RouterFunctions methods.

Specified by:

unknown in interface RouterFunctions.Visitor

Parameters:

routerFunction - the router function

indent

private void indent()

method

public void method(java.util.Set<HttpMethod> methods)

Description copied from interface: RequestPredicates.Visitor

Receive notification of an HTTP method predicate.

Specified by:

method in interface RequestPredicates.Visitor

Parameters:

methods - the HTTP methods that make up the predicate

See Also:

RequestPredicates.method(HttpMethod)

path

public void path(java.lang.String pattern)

Description copied from interface: RequestPredicates.Visitor

Receive notification of an path predicate.

Specified by:

path in interface RequestPredicates.Visitor

Parameters:

pattern - the path pattern that makes up the predicate

See Also:

RequestPredicates.path(String)

pathExtension

public void pathExtension(java.lang.String extension)

Description copied from interface: RequestPredicates.Visitor

Receive notification of an path extension predicate.

Specified by:

pathExtension in interface RequestPredicates.Visitor

Parameters:

extension - the path extension that makes up the predicate

See Also:

RequestPredicates.pathExtension(String)

header

public void header(java.lang.String name,
                   java.lang.String value)

Description copied from interface: RequestPredicates.Visitor

Receive notification of a HTTP header predicate.

Specified by:

header in interface RequestPredicates.Visitor

Parameters:

name - the name of the HTTP header to check

value - the desired value of the HTTP header

See Also:

RequestPredicates.headers(Predicate), RequestPredicates.contentType(MediaType...), RequestPredicates.accept(MediaType...)

queryParam

public void queryParam(java.lang.String name,
                       java.lang.String value)

Description copied from interface: RequestPredicates.Visitor

Receive notification of a query parameter predicate.

Specified by:

queryParam in interface RequestPredicates.Visitor

Parameters:

name - the name of the query parameter

value - the desired value of the parameter

See Also:

RequestPredicates.queryParam(String, String)

startAnd

public void startAnd()

Description copied from interface: RequestPredicates.Visitor

Receive first notification of a logical AND predicate. The first subsequent notification will contain the left-hand side of the AND-predicate; followed by RequestPredicates.Visitor.and(), followed by the right-hand side, followed by RequestPredicates.Visitor.endAnd().

Specified by:

startAnd in interface RequestPredicates.Visitor

See Also:

RequestPredicate.and(RequestPredicate)

and

public void and()

Description copied from interface: RequestPredicates.Visitor

Receive "middle" notification of a logical AND predicate. The following notification contains the right-hand side, followed by RequestPredicates.Visitor.endAnd().

Specified by:

and in interface RequestPredicates.Visitor

See Also:

RequestPredicate.and(RequestPredicate)

endAnd

public void endAnd()

Description copied from interface: RequestPredicates.Visitor

Receive last notification of a logical AND predicate.

Specified by:

endAnd in interface RequestPredicates.Visitor

See Also:

RequestPredicate.and(RequestPredicate)

startOr

public void startOr()

Description copied from interface: RequestPredicates.Visitor

Receive first notification of a logical OR predicate. The first subsequent notification will contain the left-hand side of the OR-predicate; the second notification contains the right-hand side, followed by RequestPredicates.Visitor.endOr().

Specified by:

startOr in interface RequestPredicates.Visitor

See Also:

RequestPredicate.or(RequestPredicate)

or

public void or()

Description copied from interface: RequestPredicates.Visitor

Receive "middle" notification of a logical OR predicate. The following notification contains the right-hand side, followed by RequestPredicates.Visitor.endOr().

Specified by:

or in interface RequestPredicates.Visitor

See Also:

RequestPredicate.or(RequestPredicate)

endOr

public void endOr()

Description copied from interface: RequestPredicates.Visitor

Receive last notification of a logical OR predicate.

Specified by:

endOr in interface RequestPredicates.Visitor

See Also:

RequestPredicate.or(RequestPredicate)

startNegate

public void startNegate()

Description copied from interface: RequestPredicates.Visitor

Receive first notification of a negated predicate. The first subsequent notification will contain the negated predicated, followed by RequestPredicates.Visitor.endNegate().

Specified by:

startNegate in interface RequestPredicates.Visitor

See Also:

RequestPredicate.negate()

endNegate

public void endNegate()

Description copied from interface: RequestPredicates.Visitor

Receive last notification of a negated predicate.

Specified by:

endNegate in interface RequestPredicates.Visitor

See Also:

RequestPredicate.negate()

unknown

public void unknown(RequestPredicate predicate)

Description copied from interface: RequestPredicates.Visitor

Receive first notification of an unknown predicate.

Specified by:

unknown in interface RequestPredicates.Visitor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object