Spring Framework 6.1.4 · org.springframework.web.servlet.mvc.method.RequestMappingInfo

Nested and Inner Type Summary

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

Modifier and Type

Class and Description

public static interface

RequestMappingInfo.Builder

Defines a builder for creating a RequestMappingInfo.

public static class

RequestMappingInfo.BuilderConfiguration

Container for configuration options used for request mapping purposes.

private static class

RequestMappingInfo.DefaultBuilder

private static class

RequestMappingInfo.MutateBuilder

Modifier and Type	Field and Description
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 PatternsRequestCondition	EMPTY_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 PatternsRequestCondition	patternsCondition
private final ProducesRequestCondition	producesCondition

Modifier and Type

Field and Description

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 PatternsRequestCondition

EMPTY_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 PatternsRequestCondition

patternsCondition

private final ProducesRequestCondition

producesCondition

Access	Constructor and Description
public	RequestMappingInfo(String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated as of 5.3 in favor using `RequestMappingInfo.Builder` via `paths(String...)`. Full constructor with a mapping name.
public	RequestMappingInfo(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom) Deprecated as of 5.3 in favor using `RequestMappingInfo.Builder` via `paths(String...)`. Create an instance with the given conditions.
public	RequestMappingInfo(RequestMappingInfo info, RequestCondition<?> customRequestCondition) Deprecated since 5.3 in favor of using `addCustomCondition(RequestCondition)`. Re-create a RequestMappingInfo with the given custom request condition.
private	RequestMappingInfo(String name, PathPatternsRequestCondition pathPatternsCondition, PatternsRequestCondition patternsCondition, RequestMethodsRequestCondition methodsCondition, ParamsRequestCondition paramsCondition, HeadersRequestCondition headersCondition, ConsumesRequestCondition consumesCondition, ProducesRequestCondition producesCondition, RequestConditionHolder customCondition, RequestMappingInfo.BuilderConfiguration options)

Access

Constructor and Description

public

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

Deprecated as of 5.3 in favor using RequestMappingInfo.Builder via paths(String...).

Full constructor with a mapping name.

public

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

Deprecated as of 5.3 in favor using RequestMappingInfo.Builder via paths(String...).

Create an instance with the given conditions.

public

RequestMappingInfo(RequestMappingInfo info, RequestCondition<?> customRequestCondition)

Deprecated since 5.3 in favor of using addCustomCondition(RequestCondition).

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

private

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

Method Summary

Modifier and Type	Method and Description
public RequestMappingInfo	addCustomCondition(RequestCondition<?> the custom condition to add customCondition) Create a new instance based on the current one, also adding the given custom condition.
private static int	calculateHashCode(PathPatternsRequestCondition pathPatterns, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestConditionHolder custom)
public RequestMappingInfo	Returns: a new request mapping info instance; never `null` combine(RequestMappingInfo the condition to combine with. other) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.combine. Combine "this" request mapping info (i.e. the current instance) with another request mapping info instance.
private String	combineNames(RequestMappingInfo other)
public int	compareTo(RequestMappingInfo other, HttpServletRequest request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.compareTo. Compares "this" info (i.e. the current instance) with another info in the context of a request.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public <T> RequestCondition<T>	getActivePatternsCondition() Returns either `getPathPatternsCondition()` or `getPatternsCondition()` depending on which is not null.
public ConsumesRequestCondition	getConsumesCondition() Return the "consumes" condition of this `RequestMappingInfo`; or instance with 0 consumes expressions (never `null`).
public RequestCondition<?>	getCustomCondition() Return the "custom" condition of this `RequestMappingInfo`, or `null`.
public Set<String>	getDirectPaths() Return the mapping paths that are not patterns.
public HeadersRequestCondition	getHeadersCondition() Return the "headers" condition of this `RequestMappingInfo`; or instance with 0 header expressions (never `null`).
public RequestMappingInfo	Returns: a new instance in case of a match; or `null` otherwise getMatchingCondition(HttpServletRequest request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.getMatchingCondition. 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.
public RequestMethodsRequestCondition	getMethodsCondition() Return the HTTP request methods of this `RequestMappingInfo`; or instance with 0 request methods (never `null`).
public String	getName() Return the name for this mapping, or `null`.
public ParamsRequestCondition	getParamsCondition() Return the "parameters" condition of this `RequestMappingInfo`; or instance with 0 parameter expressions (never `null`).
public PathPatternsRequestCondition	getPathPatternsCondition() Return the patterns condition in use when parsed patterns are `enabled`.
public PatternsRequestCondition	getPatternsCondition() Return the patterns condition when String pattern matching via `PathMatcher` is in use.
public Set<String>	getPatternValues() Return the patterns for the `active` patterns condition as Strings.
public ProducesRequestCondition	getProducesCondition() Return the "produces" condition of this `RequestMappingInfo`; or instance with 0 produces expressions (never `null`).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmptyMapping() Whether the request mapping has an empty URL path mapping.
public RequestMappingInfo.Builder	Returns: a builder to create a new, modified instance mutate() Return a builder to create a new RequestMappingInfo by modifying this one.
public static RequestMappingInfo.Builder	paths(String... the paths to use paths) Create a new `RequestMappingInfo.Builder` with the given paths.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

public final Class RequestMappingInfo

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary