Representation of a parsed path pattern. Includes a chain of path elements for fast matching and accumulates computed state for quick comparison of patterns.

PathPattern matches URL paths using the following rules:

? matches one character
* matches zero or more characters within a path segment
** matches zero or more path segments until the end of the path
{spring} matches a path segment and captures it as a variable named "spring"
{spring:[a-z]+} matches the regexp [a-z]+ against a path segment and captures it a path variable named "spring"
{*spring} matches zero or more path segments until the end of the path and captures it as a variable named "spring"

Note

In contrast to org.springframework.util.AntPathMatcher, ** is supported only at the end of a pattern. For example /pages/{**} is valid but /pages/{**}/details is not. The same applies also to the capturing variant {*spring}. The aim is to eliminate ambiguity when comparing patterns for specificity.

Examples

/pages/t?st.html — matches /pages/test.html as well as /pages/tXst.html but not /pages/toast.html
/resources/*.png — matches all .png files in the resources directory
/resources/** — matches all files underneath the /resources/ path, including /resources/image.png and /resources/css/spring.css
/resources/{*path} — matches all files underneath the /resources/, as well as /resources, and captures their relative path in a variable named "path"; /resources/image.png will match with "path" → "/image.png", and /resources/css/spring.css will match with "path" → "/css/spring.css"
/resources/{filename:\\w+}.dat will match /resources/spring.dat and assign the value "spring" to the filename variable

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	PathPattern.MatchingContext Encapsulates context when attempting a match.
public static class	PathPattern.PathMatchInfo Holder for URI variables and path parameters (matrix variables) extracted based on the pattern for a given matched path.
public static class	PathPattern.PathRemainingMatchInfo Holder for the result of a match on the start of a pattern.

Field Summary

Modifier and Type	Field and Description
private int	capturedVariableCount How many variables are captured in this pattern.
private final boolean	caseSensitive Will this match candidates in a case-sensitive way?
private boolean	catchAll Does the pattern end with {*...}.
private static final PathContainer	EMPTY_PATH
private boolean	endsWithSeparatorWildcard Does the pattern end with '<separator>'.
private final PathElement	head First path element in the parsed chain of path elements for this pattern.
private final boolean	matchOptionalTrailingSeparator If this pattern has no trailing slash, allow candidates to include one and still match successfully.
private int	normalizedLength The normalized length is trying to measure the 'active' part of the pattern.
private final PathPatternParser	parser The parser used to construct this pattern.
private final PathContainer.Options	pathOptions The options to use to parse a pattern.
private final String	patternString The text of the parsed pattern.
private int	score Score is used to quickly compare patterns.
public static final Comparator<PathPattern>	SPECIFICITY_COMPARATOR Comparator that sorts patterns by specificity as follows: Null instances are last. Catch-all patterns are last. If both patterns are catch-all, consider the length (longer wins). Compare wildcard and captured variable count (lower wins). Consider length (longer wins)

Constructor Summary

Access	Constructor and Description
pack-priv	PathPattern(String patternText, PathPatternParser parser, PathElement head)

Method Summary

Modifier and Type	Method and Description
public PathPattern	combine(PathPattern pattern2string) Combine this pattern with another.
public int	compareTo(PathPattern the object to be compared. otherPattern) Implements java.lang.Comparable.compareTo. Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern is more specific, the same or less specific than the supplied pattern.
pack-priv String	Returns: the string form of the pattern computePatternString() Return the string form of the pattern built from walking the path element chain.
private String	Returns: joined path that may include separator if necessary concat(String first path path1, String second path path2) Join two paths together including a separator if necessary.
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 PathContainer	Returns: the subset of the path that is matched by pattern or "" if none of it is matched by pattern elements extractPathWithinPattern(PathContainer a path that matches this pattern path) Determine the pattern-mapped part for the given path.
pack-priv int	getCapturedVariableCount()
pack-priv PathElement	getHeadSection()
pack-priv int	getNormalizedLength() The normalized length is trying to measure the 'active' part of the pattern.
public String	getPatternString() Return the original String that was parsed to create this PathPattern.
pack-priv int	getScore()
pack-priv char	getSeparator()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private boolean	Returns: `true` has more than zero elements hasLength(PathContainer a path container container) Return if the container is not null and has more than zero elements.
public boolean	hasPatternSyntax() Whether the pattern string contains pattern syntax that would require use of `matches(PathContainer)`, or if it is a regular String that could be compared directly to others.
pack-priv boolean	isCatchAll()
public PathPattern.PathMatchInfo	Returns: info object with the extracted variables, or `null` for no match matchAndExtract(PathContainer the candidate path to attempt to match against pathContainer) Match this pattern to the given URI path and return extracted URI template variables as well as path parameters (matrix variables).
public boolean	Returns: `true` if the path matches this pattern matches(PathContainer the candidate path to attempt to match against pathContainer) Whether this pattern matches the given path.
public PathPattern.PathRemainingMatchInfo	Returns: info object with the match result or `null` for no match matchStartOfPath(PathContainer the candidate path to attempt to match against pathContainer) Match the beginning of the given path and return the remaining portion not covered by this pattern.
private boolean	pathContainerIsJustSeparator(PathContainer pathContainer)
private static int	scoreByNormalizedLength(PathPattern pattern)
pack-priv String	toChainString()
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

Field Detail

capturedVariableCount	back to summary
private int capturedVariableCount How many variables are captured in this pattern.

caseSensitive	back to summary
private final boolean caseSensitive Will this match candidates in a case-sensitive way? (case sensitivity at parse time).

catchAll	back to summary
private boolean catchAll Does the pattern end with {*...}.

EMPTY_PATH	back to summary
private static final PathContainer EMPTY_PATH

endsWithSeparatorWildcard	back to summary
private boolean endsWithSeparatorWildcard Does the pattern end with '<separator>'.

head	back to summary
private final PathElement head First path element in the parsed chain of path elements for this pattern. Annotations @Nullable

matchOptionalTrailingSeparator	back to summary
private final boolean matchOptionalTrailingSeparator If this pattern has no trailing slash, allow candidates to include one and still match successfully.

normalizedLength	back to summary
private int normalizedLength The normalized length is trying to measure the 'active' part of the pattern. It is computed by assuming all captured variables have a normalized length of 1. Effectively this means changing your variable name lengths isn't going to change the length of the active part of the pattern. Useful when comparing two patterns.

parser	back to summary
private final PathPatternParser parser The parser used to construct this pattern.

pathOptions	back to summary
private final PathContainer.Options pathOptions The options to use to parse a pattern.

patternString	back to summary
private final String patternString The text of the parsed pattern.

score	back to summary
private int score Score is used to quickly compare patterns. Different pattern components are given different weights. A 'lower score' is more specific. Current weights: Captured variables are worth 1 Wildcard is worth 100

score

back to summary

private int score

Score is used to quickly compare patterns. Different pattern components are given different weights. A 'lower score' is more specific. Current weights:

Captured variables are worth 1
Wildcard is worth 100

SPECIFICITY_COMPARATOR	back to summary
public static final Comparator<PathPattern> SPECIFICITY_COMPARATOR Comparator that sorts patterns by specificity as follows: Null instances are last. Catch-all patterns are last. If both patterns are catch-all, consider the length (longer wins). Compare wildcard and captured variable count (lower wins). Consider length (longer wins)

SPECIFICITY_COMPARATOR

back to summary

public static final Comparator<PathPattern> SPECIFICITY_COMPARATOR

Comparator that sorts patterns by specificity as follows:

Null instances are last.
Catch-all patterns are last.
If both patterns are catch-all, consider the length (longer wins).
Compare wildcard and captured variable count (lower wins).
Consider length (longer wins)

Constructor Detail

PathPattern	back to summary
pack-priv PathPattern(String patternText, PathPatternParser parser, PathElement head) Annotations @SuppressWarnings:deprecation

Method Detail

combine	back to summary
public PathPattern combine(PathPattern pattern2string) Combine this pattern with another.

compareTo	back to summary
public int compareTo(PathPattern otherPattern) Implements java.lang.Comparable.compareTo. Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern is more specific, the same or less specific than the supplied pattern. The aim is to sort more specific patterns first. Parameters otherPattern:PathPattern Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

compareTo

back to summary

public int compareTo(PathPattern otherPattern)

Implements java.lang.Comparable.compareTo.

Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern is more specific, the same or less specific than the supplied pattern. The aim is to sort more specific patterns first.

Parameters

otherPattern:PathPattern

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

computePatternString	back to summary
pack-priv String computePatternString() Return the string form of the pattern built from walking the path element chain. Returns:String the string form of the pattern

computePatternString

back to summary

pack-priv String computePatternString()

Return the string form of the pattern built from walking the path element chain.

Returns:String: the string form of the pattern

concat	back to summary
private String concat(String path1, String path2) Join two paths together including a separator if necessary. Extraneous separators are removed (if the first path ends with one and the second path starts with one). Parameters path1:String first path path2:String second path Returns:String joined path that may include separator if necessary

concat

back to summary

private String concat(String path1, String path2)

Join two paths together including a separator if necessary. Extraneous separators are removed (if the first path ends with one and the second path starts with one).

Parameters

path1:String: first path
path2:String: second path

Returns:String

joined path that may include separator if necessary

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

extractPathWithinPattern back to summary

extractPathWithinPattern	back to summary
public PathContainer extractPathWithinPattern(PathContainer path) Determine the pattern-mapped part for the given path. For example: '`/docs/cvs/commit.html`' and '`/docs/cvs/commit.html` → '' '`/docs/`' and '`/docs/cvs/commit`' → '`cvs/commit`' '`/docs/cvs/.html`' and '`/docs/cvs/commit.html` → '`commit.html`' '`/docs/`' and '`/docs/cvs/commit` → '`cvs/commit`' Notes: Assumes that `matches` returns `true` for the same path but does not** enforce this. Duplicate occurrences of separators within the returned result are removed Leading and trailing separators are removed from the returned result Parameters path:PathContainer a path that matches this pattern Returns:PathContainer the subset of the path that is matched by pattern or "" if none of it is matched by pattern elements

public PathContainer extractPathWithinPattern(PathContainer path)

Determine the pattern-mapped part for the given path.

For example:

'/docs/cvs/commit.html' and '/docs/cvs/commit.html → ''
'/docs/*' and '/docs/cvs/commit' → 'cvs/commit'
'/docs/cvs/*.html' and '/docs/cvs/commit.html → 'commit.html'
'/docs/**' and '/docs/cvs/commit → 'cvs/commit'

Notes:

Assumes that matches returns true for the same path but does not enforce this.
Duplicate occurrences of separators within the returned result are removed
Leading and trailing separators are removed from the returned result

Parameters

path:PathContainer: a path that matches this pattern

Returns:PathContainer

the subset of the path that is matched by pattern or "" if none of it is matched by pattern elements

getCapturedVariableCount	back to summary
pack-priv int getCapturedVariableCount()

getHeadSection	back to summary
pack-priv PathElement getHeadSection() Annotations @Nullable

getNormalizedLength	back to summary
pack-priv int getNormalizedLength() The normalized length is trying to measure the 'active' part of the pattern. It is computed by assuming all capture variables have a normalized length of 1. Effectively this means changing your variable name lengths isn't going to change the length of the active part of the pattern. Useful when comparing two patterns.

getPatternString	back to summary
public String getPatternString() Return the original String that was parsed to create this PathPattern.

getScore	back to summary
pack-priv int getScore()

getSeparator	back to summary
pack-priv char getSeparator()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasLength back to summary

hasLength	back to summary
private boolean hasLength(PathContainer container) Return if the container is not null and has more than zero elements. Parameters container:PathContainer a path container Returns:boolean `true` has more than zero elements

private boolean hasLength(PathContainer container)

Return if the container is not null and has more than zero elements.

Parameters

container:PathContainer: a path container

Returns:boolean

true has more than zero elements

hasPatternSyntax back to summary

hasPatternSyntax	back to summary
public boolean hasPatternSyntax() Whether the pattern string contains pattern syntax that would require use of `matches(PathContainer)`, or if it is a regular String that could be compared directly to others. Since 5.2

public boolean hasPatternSyntax()

Whether the pattern string contains pattern syntax that would require use of matches(PathContainer), or if it is a regular String that could be compared directly to others.

Since: 5.2

isCatchAll	back to summary
pack-priv boolean isCatchAll()

matchAndExtract back to summary

matchAndExtract	back to summary
public PathPattern.PathMatchInfo matchAndExtract(PathContainer pathContainer) Match this pattern to the given URI path and return extracted URI template variables as well as path parameters (matrix variables). Parameters pathContainer:PathContainer the candidate path to attempt to match against Returns:PathPattern.PathMatchInfo info object with the extracted variables, or `null` for no match Annotations @Nullable

public PathPattern.PathMatchInfo matchAndExtract(PathContainer pathContainer)

Match this pattern to the given URI path and return extracted URI template variables as well as path parameters (matrix variables).

Parameters

pathContainer:PathContainer: the candidate path to attempt to match against

Returns:PathPattern.PathMatchInfo

info object with the extracted variables, or null for no match

Annotations

@Nullable

matches back to summary

matches	back to summary
public boolean matches(PathContainer pathContainer) Whether this pattern matches the given path. Parameters pathContainer:PathContainer the candidate path to attempt to match against Returns:boolean `true` if the path matches this pattern

public boolean matches(PathContainer pathContainer)

Whether this pattern matches the given path.

Parameters

pathContainer:PathContainer: the candidate path to attempt to match against

Returns:boolean

true if the path matches this pattern

matchStartOfPath back to summary

matchStartOfPath	back to summary
public PathPattern.PathRemainingMatchInfo matchStartOfPath(PathContainer pathContainer) Match the beginning of the given path and return the remaining portion not covered by this pattern. This is useful for matching nested routes where the path is matched incrementally at each level. Parameters pathContainer:PathContainer the candidate path to attempt to match against Returns:PathPattern.PathRemainingMatchInfo info object with the match result or `null` for no match Annotations @Nullable

public PathPattern.PathRemainingMatchInfo matchStartOfPath(PathContainer pathContainer)

Match the beginning of the given path and return the remaining portion not covered by this pattern. This is useful for matching nested routes where the path is matched incrementally at each level.

Parameters

pathContainer:PathContainer: the candidate path to attempt to match against

Returns:PathPattern.PathRemainingMatchInfo

info object with the match result or null for no match

Annotations

@Nullable

pathContainerIsJustSeparator	back to summary
private boolean pathContainerIsJustSeparator(PathContainer pathContainer)

scoreByNormalizedLength	back to summary
private static int scoreByNormalizedLength(PathPattern pattern)

toChainString	back to summary
pack-priv String toChainString()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.springframework.web.util.pattern back to summary

pack-priv Class PathPattern.MatchingContext

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.util.pattern.PathPattern.MatchingContext

Encapsulates context when attempting a match. Includes some fixed state like the candidate currently being considered for a match but also some accumulators for extracted variables.

Field Summary

Modifier and Type	Field and Description
pack-priv final PathContainer	candidate
pack-priv boolean	determineRemainingPath
private Map<String, MultiValueMap<String, String>>	extractedMatrixVariables
private Map<String, String>	extractedUriVariables
pack-priv boolean	extractingVariables
pack-priv final List<PathContainer.Element>	pathElements
pack-priv final int	pathLength
pack-priv int	remainingPathIndex

Constructor Summary

Access	Constructor and Description
public	MatchingContext(PathContainer pathContainer, boolean extractVariables)

Method Summary

Modifier and Type	Method and Description
public PathPattern.PathMatchInfo	getPathMatchResult()
public boolean	isMatchOptionalTrailingSeparator()
pack-priv boolean	Returns: `true` if element is a separator isSeparator(int possible index of a separator pathIndex) Return if element at specified index is a separator.
pack-priv String	Returns: the decoded value pathElementValue(int path element index pathIndex) Return the decoded value of the specified element.
public void	set(String key, String value, MultiValueMap<String, String> parameters)
public void	setMatchAllowExtraPath()

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

Field Detail

candidate	back to summary
pack-priv final PathContainer candidate

determineRemainingPath	back to summary
pack-priv boolean determineRemainingPath

extractedMatrixVariables	back to summary
private Map<String, MultiValueMap<String, String>> extractedMatrixVariables Annotations @Nullable

extractedUriVariables	back to summary
private Map<String, String> extractedUriVariables Annotations @Nullable

extractingVariables	back to summary
pack-priv boolean extractingVariables

pathElements	back to summary
pack-priv final List<PathContainer.Element> pathElements

pathLength	back to summary
pack-priv final int pathLength

remainingPathIndex	back to summary
pack-priv int remainingPathIndex

Constructor Detail

MatchingContext	back to summary
public MatchingContext(PathContainer pathContainer, boolean extractVariables)

Method Detail

getPathMatchResult	back to summary
public PathPattern.PathMatchInfo getPathMatchResult()

isMatchOptionalTrailingSeparator	back to summary
public boolean isMatchOptionalTrailingSeparator()

isSeparator back to summary

pack-priv boolean isSeparator(int pathIndex)

Return if element at specified index is a separator.

Parameters

pathIndex:int: possible index of a separator

Returns:boolean

true if element is a separator

pathElementValue

back to summary

pack-priv String pathElementValue(int pathIndex)

Return the decoded value of the specified element.

Parameters

pathIndex:int: path element index

Returns:String

the decoded value

set	back to summary
public void set(String key, String value, MultiValueMap<String, String> parameters)

setMatchAllowExtraPath	back to summary
public void setMatchAllowExtraPath()

org.springframework.web.util.pattern back to summary

public Class PathPattern.PathMatchInfo

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.util.pattern.PathPattern.PathMatchInfo

Holder for URI variables and path parameters (matrix variables) extracted based on the pattern for a given matched path.

Field Summary

Modifier and Type	Field and Description
private static final PathPattern.PathMatchInfo	EMPTY
private final Map<String, MultiValueMap<String, String>>	matrixVariables
private final Map<String, String>	uriVariables

Constructor Summary

Access	Constructor and Description
pack-priv	PathMatchInfo(Map<String, String> uriVars, Map<String, MultiValueMap<String, String>> matrixVars)

Method Summary

Modifier and Type	Method and Description
public Map<String, MultiValueMap<String, String>>	getMatrixVariables() Return maps of matrix variables per path segment, keyed off by URI variable name.
public Map<String, String>	getUriVariables() Return the extracted URI variables.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

EMPTY	back to summary
private static final PathPattern.PathMatchInfo EMPTY

matrixVariables	back to summary
private final Map<String, MultiValueMap<String, String>> matrixVariables

uriVariables	back to summary
private final Map<String, String> uriVariables

Constructor Detail

PathMatchInfo	back to summary
pack-priv PathMatchInfo(Map<String, String> uriVars, Map<String, MultiValueMap<String, String>> matrixVars)

Method Detail

getMatrixVariables	back to summary
public Map<String, MultiValueMap<String, String>> getMatrixVariables() Return maps of matrix variables per path segment, keyed off by URI variable name.

getUriVariables	back to summary
public Map<String, String> getUriVariables() Return the extracted URI variables.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.springframework.web.util.pattern back to summary

public Class PathPattern.PathRemainingMatchInfo

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.util.pattern.PathPattern.PathRemainingMatchInfo

Holder for the result of a match on the start of a pattern. Provides access to the remaining path not matched to the pattern as well as any variables bound in that first part that was matched.

Field Summary

Modifier and Type	Field and Description
private final PathContainer	pathMatched
private final PathPattern.PathMatchInfo	pathMatchInfo
private final PathContainer	pathRemaining

Constructor Summary

Access	Constructor and Description
pack-priv	PathRemainingMatchInfo(PathContainer pathMatched, PathContainer pathRemaining)
pack-priv	PathRemainingMatchInfo(PathContainer pathMatched, PathContainer pathRemaining, PathPattern.PathMatchInfo pathMatchInfo)

Method Summary

Modifier and Type	Method and Description
public Map<String, MultiValueMap<String, String>>	getMatrixVariables() Return the path parameters for each bound variable.
public PathContainer	getPathMatched() Return the part of a path that was matched by a pattern.
public PathContainer	getPathRemaining() Return the part of a path that was not matched by a pattern.
public Map<String, String>	getUriVariables() Return variables that were bound in the part of the path that was successfully matched or an empty map.

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

Field Detail

pathMatched	back to summary
private final PathContainer pathMatched

pathMatchInfo	back to summary
private final PathPattern.PathMatchInfo pathMatchInfo

pathRemaining	back to summary
private final PathContainer pathRemaining

Constructor Detail

PathRemainingMatchInfo	back to summary
pack-priv PathRemainingMatchInfo(PathContainer pathMatched, PathContainer pathRemaining)

PathRemainingMatchInfo	back to summary
pack-priv PathRemainingMatchInfo(PathContainer pathMatched, PathContainer pathRemaining, PathPattern.PathMatchInfo pathMatchInfo)

Method Detail

getMatrixVariables	back to summary
public Map<String, MultiValueMap<String, String>> getMatrixVariables() Return the path parameters for each bound variable.

getPathMatched

back to summary

public PathContainer getPathMatched()

Return the part of a path that was matched by a pattern.

Since: 5.3

getPathRemaining	back to summary
public PathContainer getPathRemaining() Return the part of a path that was not matched by a pattern.

getUriVariables	back to summary
public Map<String, String> getUriVariables() Return variables that were bound in the part of the path that was successfully matched or an empty map.