Spring Framework 6.1.4 · org.springframework.web.servlet.function.RequestPredicate

Method Summary

Modifier and Type	Method and Description
public default void	accept(RequestPredicates.Visitor the visitor to accept visitor) Accept the given visitor.
public default RequestPredicate	Returns: a predicate composed of this predicate AND the `other` predicate and(RequestPredicate a predicate that will be logically-ANDed with this predicate other) Return a composed request predicate that tests against both this predicate AND the `other` predicate.
public default RequestPredicate	Returns: a predicate that represents the logical negation of this predicate negate() Return a predicate that represents the logical negation of this predicate.
public default Optional<ServerRequest>	Returns: the nested request nest(ServerRequest the request to be nested request) Transform the given request into a request used for a nested route.
public default RequestPredicate	Returns: a predicate composed of this predicate OR the `other` predicate or(RequestPredicate a predicate that will be logically-ORed with this predicate other) Return a composed request predicate that tests against both this predicate OR the `other` predicate.
public boolean	Returns: `true` if the request matches the predicate; `false` otherwise test(ServerRequest the request to match against request) Evaluate this predicate on the given request.

Method Detail

accept back to summary

accept	back to summary
public default void accept(RequestPredicates.Visitor visitor) Accept the given visitor. Default implementation calls `RequestPredicates.Visitor#unknown(RequestPredicate)`; composed `RequestPredicate` implementations are expected to call `accept` for all components that make up this request predicate. Parameters visitor:RequestPredicates.Visitor the visitor to accept

public default void accept(RequestPredicates.Visitor visitor)

Accept the given visitor. Default implementation calls RequestPredicates.Visitor#unknown(RequestPredicate); composed RequestPredicate implementations are expected to call accept for all components that make up this request predicate.

Parameters

visitor:RequestPredicates.Visitor: the visitor to accept

and back to summary

and	back to summary
public default RequestPredicate and(RequestPredicate other) Return a composed request predicate that tests against both this predicate AND the `other` predicate. When evaluating the composed predicate, if this predicate is `false`, then the `other` predicate is not evaluated. Parameters other:RequestPredicate a predicate that will be logically-ANDed with this predicate Returns:RequestPredicate a predicate composed of this predicate AND the `other` predicate

public default RequestPredicate and(RequestPredicate other)

Return a composed request predicate that tests against both this predicate AND the other predicate. When evaluating the composed predicate, if this predicate is false, then the other predicate is not evaluated.

Parameters

other:RequestPredicate: a predicate that will be logically-ANDed with this predicate

Returns:RequestPredicate

a predicate composed of this predicate AND the other predicate

negate	back to summary
public default RequestPredicate negate() Return a predicate that represents the logical negation of this predicate. Returns:RequestPredicate a predicate that represents the logical negation of this predicate

negate

back to summary

public default RequestPredicate negate()

Return a predicate that represents the logical negation of this predicate.

Returns:RequestPredicate: a predicate that represents the logical negation of this predicate

nest back to summary

nest	back to summary
public default Optional<ServerRequest> nest(ServerRequest request) Transform the given request into a request used for a nested route. For instance, a path-based predicate can return a `ServerRequest` with a path remaining after a match. The default implementation returns an `Optional` wrapping the given request if `test(ServerRequest)` evaluates to `true`; or `Optional#empty()` if it evaluates to `false`. Parameters request:ServerRequest the request to be nested Returns:Optional<ServerRequest> the nested request See Also `RouterFunctions#nest(RequestPredicate, RouterFunction)`

public default Optional<ServerRequest> nest(ServerRequest request)

Transform the given request into a request used for a nested route. For instance, a path-based predicate can return a ServerRequest with a path remaining after a match.

The default implementation returns an Optional wrapping the given request if test(ServerRequest) evaluates to true; or Optional#empty() if it evaluates to false.

Parameters

request:ServerRequest: the request to be nested

Returns:Optional<ServerRequest>

the nested request

or back to summary

or	back to summary
public default RequestPredicate or(RequestPredicate other) Return a composed request predicate that tests against both this predicate OR the `other` predicate. When evaluating the composed predicate, if this predicate is `true`, then the `other` predicate is not evaluated. Parameters other:RequestPredicate a predicate that will be logically-ORed with this predicate Returns:RequestPredicate a predicate composed of this predicate OR the `other` predicate

public default RequestPredicate or(RequestPredicate other)

Return a composed request predicate that tests against both this predicate OR the other predicate. When evaluating the composed predicate, if this predicate is true, then the other predicate is not evaluated.

Parameters

other:RequestPredicate: a predicate that will be logically-ORed with this predicate

Returns:RequestPredicate

a predicate composed of this predicate OR the other predicate

test back to summary

test	back to summary
public boolean test(ServerRequest request) Evaluate this predicate on the given request. Parameters request:ServerRequest the request to match against Returns:boolean `true` if the request matches the predicate; `false` otherwise

public boolean test(ServerRequest request)

Evaluate this predicate on the given request.

Parameters

request:ServerRequest: the request to match against

Returns:boolean

true if the request matches the predicate; false otherwise

public Interface RequestPredicate

Method Summary

Method Detail