org.springframework.web.servlet.mvc.method

Class RequestMappingInfo

java.lang.Object

org.springframework.web.servlet.mvc.method.RequestMappingInfo

All Implemented Interfaces:

RequestCondition<RequestMappingInfo>

public final class RequestMappingInfo
extends java.lang.Object
implements RequestCondition<RequestMappingInfo>

A RequestCondition that consists of the following other conditions:

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

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestMappingInfo.Builder Defines a builder for creating a RequestMappingInfo.
static class	RequestMappingInfo.BuilderConfiguration Container for configuration options used for request mapping purposes.

Constructor Summary

Constructors

Constructor and Description
RequestMappingInfo(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Creates a new instance with the given request conditions.
RequestMappingInfo(RequestMappingInfo info, RequestCondition<?> customRequestCondition) Re-create a RequestMappingInfo with the given custom request condition.
RequestMappingInfo(java.lang.String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom)

Method Summary

Modifier and Type	Method and Description
RequestMappingInfo	combine(RequestMappingInfo other) Combine "this" request mapping info (i.e.
int	compareTo(RequestMappingInfo other, HttpServletRequest request) Compares "this" info (i.e.
boolean	equals(java.lang.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.
HeadersRequestCondition	getHeadersCondition() Return the "headers" condition of this RequestMappingInfo; or instance with 0 header expressions (never null).
RequestMappingInfo	getMatchingCondition(HttpServletRequest 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).
java.lang.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).
PatternsRequestCondition	getPatternsCondition() Return the URL patterns of this RequestMappingInfo; or instance with 0 patterns (never null).
ProducesRequestCondition	getProducesCondition() Return the "produces" condition of this RequestMappingInfo; or instance with 0 produces expressions (never null).
int	hashCode()
static RequestMappingInfo.Builder	paths(java.lang.String... paths) Create a new RequestMappingInfo.Builder with the given paths.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestMappingInfo

public RequestMappingInfo(@Nullable
                          java.lang.String name,
                          @Nullable
                          PatternsRequestCondition patterns,
                          @Nullable
                          RequestMethodsRequestCondition methods,
                          @Nullable
                          ParamsRequestCondition params,
                          @Nullable
                          HeadersRequestCondition headers,
                          @Nullable
                          ConsumesRequestCondition consumes,
                          @Nullable
                          ProducesRequestCondition produces,
                          @Nullable
                          RequestCondition<?> custom)

RequestMappingInfo

public RequestMappingInfo(@Nullable
                          PatternsRequestCondition patterns,
                          @Nullable
                          RequestMethodsRequestCondition methods,
                          @Nullable
                          ParamsRequestCondition params,
                          @Nullable
                          HeadersRequestCondition headers,
                          @Nullable
                          ConsumesRequestCondition consumes,
                          @Nullable
                          ProducesRequestCondition produces,
                          @Nullable
                          RequestCondition<?> custom)

Creates a new instance with the given request conditions.

RequestMappingInfo

public RequestMappingInfo(RequestMappingInfo info,
                          @Nullable
                          RequestCondition<?> customRequestCondition)

Re-create a RequestMappingInfo with the given custom request condition.

Method Detail

getName

@Nullable
public java.lang.String getName()

Return the name for this mapping, or null.

getPatternsCondition

public PatternsRequestCondition getPatternsCondition()

Return the URL patterns of this RequestMappingInfo; or instance with 0 patterns (never null).

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.

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.

Specified by:

combine in interface RequestCondition<RequestMappingInfo>

Parameters:

other - the condition to combine with.

Returns:

a new request mapping info instance; never null

getMatchingCondition

@Nullable
public RequestMappingInfo getMatchingCondition(HttpServletRequest 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.

Specified by:

getMatchingCondition in interface RequestCondition<RequestMappingInfo>

Returns:

a new instance in case all conditions match; or null otherwise

compareTo

public int compareTo(RequestMappingInfo other,
                     HttpServletRequest 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(HttpServletRequest) to ensure they have conditions with content relevant to current request.

Specified by:

compareTo in interface RequestCondition<RequestMappingInfo>

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

paths

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

Create a new RequestMappingInfo.Builder with the given paths.

Parameters:

paths - the paths to use

Since:

4.2