Spring Framework 6.1.4 · org.springframework.web.servlet.handler.RequestMatchResult

Container for the result from request pattern matching via MatchableHandlerMapping with a method to further extract URI template variables from the pattern.

Field Summary

Modifier and Type	Field and Description
private final String	lookupPath
private final PathContainer	lookupPathContainer
private final PathMatcher	pathMatcher
private final PathPattern	pathPattern
private final String	pattern

Constructor Summary

Access	Constructor and Description
public	RequestMatchResult(PathPattern the pattern that was matched pathPattern, PathContainer the mapping path lookupPath) Create an instance with the matched `PathPattern`.
public	RequestMatchResult(String the pattern that was matched, possibly with a '/' appended pattern, String the mapping path lookupPath, PathMatcher the PathMatcher instance used for the match pathMatcher) Create an instance with the matched String pattern.

Method Summary

Modifier and Type	Method and Description
public Map<String, String>	Returns: a map with URI template variables extractUriTemplateVariables() Extract URI template variables from the matching pattern as defined in `PathMatcher#extractUriTemplateVariables`.

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

Field Detail

lookupPath	back to summary
private final String lookupPath Annotations @Nullable

lookupPathContainer	back to summary
private final PathContainer lookupPathContainer Annotations @Nullable

pathMatcher	back to summary
private final PathMatcher pathMatcher Annotations @Nullable

pathPattern	back to summary
private final PathPattern pathPattern Annotations @Nullable

pattern	back to summary
private final String pattern Annotations @Nullable

Constructor Detail

RequestMatchResult back to summary

RequestMatchResult	back to summary
public RequestMatchResult(PathPattern pathPattern, PathContainer lookupPath) Create an instance with the matched `PathPattern`. Parameters pathPattern:PathPattern the pattern that was matched lookupPath:PathContainer the mapping path Since 5.3

public RequestMatchResult(PathPattern pathPattern, PathContainer lookupPath)

Create an instance with the matched PathPattern.

Parameters

pathPattern:PathPattern: the pattern that was matched
lookupPath:PathContainer: the mapping path

Since

5.3

RequestMatchResult	back to summary
public RequestMatchResult(String pattern, String lookupPath, PathMatcher pathMatcher) Create an instance with the matched String pattern. Parameters pattern:String the pattern that was matched, possibly with a '/' appended lookupPath:String the mapping path pathMatcher:PathMatcher the PathMatcher instance used for the match

RequestMatchResult

back to summary

public RequestMatchResult(String pattern, String lookupPath, PathMatcher pathMatcher)

Create an instance with the matched String pattern.

Parameters

pattern:String: the pattern that was matched, possibly with a '/' appended
lookupPath:String: the mapping path
pathMatcher:PathMatcher: the PathMatcher instance used for the match

Method Detail

extractUriTemplateVariables back to summary

extractUriTemplateVariables	back to summary
public Map<String, String> extractUriTemplateVariables() Extract URI template variables from the matching pattern as defined in `PathMatcher#extractUriTemplateVariables`. Returns:Map<String, String> a map with URI template variables Annotations @SuppressWarnings:ConstantConditions

public Map<String, String> extractUriTemplateVariables()

Extract URI template variables from the matching pattern as defined in PathMatcher#extractUriTemplateVariables.

Returns:Map<String, String>

a map with URI template variables

Annotations

@SuppressWarnings:ConstantConditions