Package de.craftsblock.craftsnet.api.requirements.web

Class QueryParameterRequirement

java.lang.Object

de.craftsblock.craftsnet.api.requirements.Requirement<Request,RouteRegistry.EndpointMapping>

de.craftsblock.craftsnet.api.requirements.web.WebRequirement

de.craftsblock.craftsnet.api.requirements.web.QueryParameterRequirement

public class QueryParameterRequirement
extends WebRequirement

A specific web requirement that checks if the url parameter list of an HTTP request matches certain criteria.

Since:

3.0.6-SNAPSHOT

See Also:

• WebRequirement

Constructor Summary

Constructors

Constructor	Description
QueryParameterRequirement()	Constructs a new query parameter requirement.

Method Summary

Modifier and Type	Method	Description
boolean	applies(Request request, RouteRegistry.EndpointMapping endpointMapping)	Checks if the requirement applies given the specified request and endpoint mapping.

Methods inherited from class de.craftsblock.craftsnet.api.requirements.Requirement

getAnnotation

Methods inherited from class java.lang.Object

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

Constructor Details

QueryParameterRequirement

public QueryParameterRequirement()

Constructs a new query parameter requirement.

Method Details

applies

public boolean applies(Request request,
 RouteRegistry.EndpointMapping endpointMapping)

Checks if the requirement applies given the specified request and endpoint mapping.

Specified by:

applies in class Requirement<Request,RouteRegistry.EndpointMapping>

Parameters:

request - the HTTP request

endpointMapping - the endpoint mapping

Returns:

true if the requirement applies, false otherwise