程序包 cn.taketoday.web.handler.method

类 RequestMappingInfo

java.lang.Object

cn.taketoday.web.handler.method.RequestMappingInfo

所有已实现的接口:

RequestCondition<RequestMappingInfo>

public final class RequestMappingInfo
extends Object
implements RequestCondition<RequestMappingInfo>

Request mapping information. A composite for the following conditions:

1. PathPatternsRequestCondition with parsed PathPatterns
2. RequestMethodsRequestCondition
3. ParamsRequestCondition
4. HeadersRequestCondition
5. ConsumesRequestCondition
6. ProducesRequestCondition
7. RequestCondition (optional, custom request condition)

从以下版本开始:

4.0 2022/4/1 21:41

作者:

Arjen Poutsma, Rossen Stoyanchev, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
static interface	RequestMappingInfo.Builder	Defines a builder for creating a RequestMappingInfo.
static class	RequestMappingInfo.BuilderConfiguration	Container for configuration options used for request mapping purposes.
private static class	RequestMappingInfo.DefaultBuilder
private static class	RequestMappingInfo.MutateBuilder

字段概要

字段

修饰符和类型	字段	说明
private final boolean	combine
private final ConsumesRequestCondition	consumesCondition
private final RequestConditionHolder	customConditionHolder
private static final ConsumesRequestCondition	EMPTY_CONSUMES
private static final RequestConditionHolder	EMPTY_CUSTOM
private static final HeadersRequestCondition	EMPTY_HEADERS
private static final ParamsRequestCondition	EMPTY_PARAMS
private static final PathPatternsRequestCondition	EMPTY_PATH_PATTERNS
private static final ProducesRequestCondition	EMPTY_PRODUCES
private static final RequestMethodsRequestCondition	EMPTY_REQUEST_METHODS
private final int	hashCode
private final HeadersRequestCondition	headersCondition
private final RequestMethodsRequestCondition	methodsCondition
private final String	name
private final RequestMappingInfo.BuilderConfiguration	options
private final ParamsRequestCondition	paramsCondition
private final PathPatternsRequestCondition	pathPatternsCondition
private final ProducesRequestCondition	producesCondition

构造器概要

构造器

构造器

说明

RequestMappingInfo(String name, PathPatternsRequestCondition pathPatternsCondition, RequestMethodsRequestCondition methodsCondition, ParamsRequestCondition paramsCondition, HeadersRequestCondition headersCondition, ConsumesRequestCondition consumesCondition, ProducesRequestCondition producesCondition, RequestConditionHolder customCondition, RequestMappingInfo.BuilderConfiguration options, boolean combine)

方法概要

修饰符和类型	方法	说明
RequestMappingInfo	addCustomCondition(RequestCondition<?> customCondition)	Create a new instance based on the current one, also adding the given custom condition.
private static int	calculateHashCode(PathPatternsRequestCondition pathPatterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestConditionHolder custom)
RequestMappingInfo	combine(RequestMappingInfo other)	Combine "this" request mapping info (i.e. the current instance) with another request mapping info instance.
private String	combineNames(RequestMappingInfo other)
int	compareTo(RequestMappingInfo other, RequestContext request)	Compares "this" info (i.e. the current instance) with another info in the context of a request.
boolean	equals(Object other)
ConsumesRequestCondition	getConsumesCondition()	Return the "consumes" condition of this RequestMappingInfo; or instance with 0 consumes expressions (never null).
RequestCondition<?>	getCustomCondition()	Return the "custom" condition of this RequestMappingInfo, or null.
Set<String>	getDirectPaths()	Return the mapping paths that are not patterns.
HeadersRequestCondition	getHeadersCondition()	Return the "headers" condition of this RequestMappingInfo; or instance with 0 header expressions (never null).
RequestMappingInfo	getMatchingCondition(RequestContext request)	Checks if all conditions in this request mapping info match the provided request and returns a potentially new request mapping info with conditions tailored to the current request.
RequestMethodsRequestCondition	getMethodsCondition()	Return the HTTP request methods of this RequestMappingInfo; or instance with 0 request methods (never null).
String	getName()	Return the name for this mapping, or null.
ParamsRequestCondition	getParamsCondition()	Return the "parameters" condition of this RequestMappingInfo; or instance with 0 parameter expressions (never null).
PathPatternsRequestCondition	getPathPatternsCondition()	Return the patterns condition
Set<String>	getPatternValues()	Return the patterns for the active patterns condition as Strings.
ProducesRequestCondition	getProducesCondition()	Return the "produces" condition of this RequestMappingInfo; or instance with 0 produces expressions (never null).
int	hashCode()
boolean	isCombine()
RequestMappingInfo.Builder	mutate()	Return a builder to create a new RequestMappingInfo by modifying this one.
static RequestMappingInfo.Builder	paths(String... paths)	Create a new RequestMappingInfo.Builder with the given paths.
String	toString()

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

EMPTY_PARAMS

private static final ParamsRequestCondition EMPTY_PARAMS

EMPTY_HEADERS

private static final HeadersRequestCondition EMPTY_HEADERS

EMPTY_CUSTOM

private static final RequestConditionHolder EMPTY_CUSTOM

EMPTY_CONSUMES

private static final ConsumesRequestCondition EMPTY_CONSUMES

EMPTY_PRODUCES

private static final ProducesRequestCondition EMPTY_PRODUCES

EMPTY_PATH_PATTERNS

private static final PathPatternsRequestCondition EMPTY_PATH_PATTERNS

EMPTY_REQUEST_METHODS

private static final RequestMethodsRequestCondition EMPTY_REQUEST_METHODS

name

@Nullable
private final String name

methodsCondition

private final RequestMethodsRequestCondition methodsCondition

pathPatternsCondition

private final PathPatternsRequestCondition pathPatternsCondition

paramsCondition

private final ParamsRequestCondition paramsCondition

headersCondition

private final HeadersRequestCondition headersCondition

consumesCondition

private final ConsumesRequestCondition consumesCondition

producesCondition

private final ProducesRequestCondition producesCondition

customConditionHolder

private final RequestConditionHolder customConditionHolder

hashCode

private final int hashCode

options

private final RequestMappingInfo.BuilderConfiguration options

combine

private final boolean combine

构造器详细资料

RequestMappingInfo

RequestMappingInfo(@Nullable
 String name,
 PathPatternsRequestCondition pathPatternsCondition,
 RequestMethodsRequestCondition methodsCondition,
 ParamsRequestCondition paramsCondition,
 HeadersRequestCondition headersCondition,
 ConsumesRequestCondition consumesCondition,
 ProducesRequestCondition producesCondition,
 RequestConditionHolder customCondition,
 RequestMappingInfo.BuilderConfiguration options,
 boolean combine)

方法详细资料

getName

@Nullable
public String getName()

Return the name for this mapping, or null.

getPathPatternsCondition

public PathPatternsRequestCondition getPathPatternsCondition()

Return the patterns condition

另请参阅:

• getPathPatternsCondition()

getDirectPaths

public Set<String> getDirectPaths()

Return the mapping paths that are not patterns.

getPatternValues

public Set<String> getPatternValues()

Return the patterns for the active patterns condition as Strings.

getMethodsCondition

public RequestMethodsRequestCondition getMethodsCondition()

Return the HTTP request methods of this RequestMappingInfo; or instance with 0 request methods (never null).

getParamsCondition

public ParamsRequestCondition getParamsCondition()

Return the "parameters" condition of this RequestMappingInfo; or instance with 0 parameter expressions (never null).

getHeadersCondition

public HeadersRequestCondition getHeadersCondition()

Return the "headers" condition of this RequestMappingInfo; or instance with 0 header expressions (never null).

getConsumesCondition

public ConsumesRequestCondition getConsumesCondition()

Return the "consumes" condition of this RequestMappingInfo; or instance with 0 consumes expressions (never null).

getProducesCondition

public ProducesRequestCondition getProducesCondition()

Return the "produces" condition of this RequestMappingInfo; or instance with 0 produces expressions (never null).

getCustomCondition

@Nullable
public RequestCondition<?> getCustomCondition()

Return the "custom" condition of this RequestMappingInfo, or null.

isCombine

public boolean isCombine()

addCustomCondition

public RequestMappingInfo addCustomCondition(RequestCondition<?> customCondition)

Create a new instance based on the current one, also adding the given custom condition.

参数:

customCondition - the custom condition to add

combine

public RequestMappingInfo combine(RequestMappingInfo other)

Combine "this" request mapping info (i.e. the current instance) with another request mapping info instance.

Example: combine type- and method-level request mappings.

指定者:

combine 在接口中 RequestCondition<RequestMappingInfo>

参数:

other - the condition to combine with.

返回:

a new request mapping info instance; never null

combineNames

@Nullable
private String combineNames(RequestMappingInfo other)

getMatchingCondition

@Nullable
public RequestMappingInfo getMatchingCondition(RequestContext request)

Checks if all conditions in this request mapping info match the provided request and returns a potentially new request mapping info with conditions tailored to the current request.

For example the returned instance may contain the subset of URL patterns that match to the current request, sorted with best matching patterns on top.

指定者:

getMatchingCondition 在接口中 RequestCondition<RequestMappingInfo>

参数:

request - the current request context

返回:

a new instance in case of a match; or null otherwise

compareTo

public int compareTo(RequestMappingInfo other,
 RequestContext request)

Compares "this" info (i.e. the current instance) with another info in the context of a request.

Note: It is assumed both instances have been obtained via getMatchingCondition(RequestContext) to ensure they have conditions with content relevant to current request.

指定者:

compareTo 在接口中 RequestCondition<RequestMappingInfo>

request - the current request context

equals

public boolean equals(@Nullable
 Object other)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

calculateHashCode

private static int calculateHashCode(PathPatternsRequestCondition pathPatterns,
 RequestMethodsRequestCondition methods,
 ParamsRequestCondition params,
 HeadersRequestCondition headers,
 ConsumesRequestCondition consumes,
 ProducesRequestCondition produces,
 RequestConditionHolder custom)

toString

public String toString()

覆盖:

toString 在类中 Object

mutate

public RequestMappingInfo.Builder mutate()

Return a builder to create a new RequestMappingInfo by modifying this one.

返回:

a builder to create a new, modified instance

paths

public static RequestMappingInfo.Builder paths(String... paths)

Create a new RequestMappingInfo.Builder with the given paths.

参数:

paths - the paths to use