org.springframework.web.util.pattern

Class PathPatternRouteMatcher

java.lang.Object

org.springframework.web.util.pattern.PathPatternRouteMatcher

All Implemented Interfaces:

RouteMatcher

public class PathPatternRouteMatcher
extends Object
implements RouteMatcher

RouteMatcher built on PathPatternParser that uses PathContainer and PathPattern as parsed representations of routes and patterns.

Since:

5.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.util.RouteMatcher

RouteMatcher.Route

Constructor Summary

Constructors

Constructor and Description
PathPatternRouteMatcher() Default constructor with PathPatternParser customized for MESSAGE_ROUTE and without matching of trailing separator.
PathPatternRouteMatcher(PathPatternParser parser) Constructor with given PathPatternParser.

Method Summary

Modifier and Type	Method and Description
String	combine(String pattern1, String pattern2) Combines two patterns into a single pattern.
Comparator<String>	getPatternComparator(RouteMatcher.Route route) Given a route, return a Comparator suitable for sorting patterns in order of explicitness for that route, so that more specific patterns come before more generic ones.
boolean	isPattern(String route) Whether the given route contains pattern syntax which requires the RouteMatcher.match(String, Route) method, or if it is a regular String that could be compared directly to others.
boolean	match(String pattern, RouteMatcher.Route route) Match the given route against the given pattern.
Map<String,String>	matchAndExtract(String pattern, RouteMatcher.Route route) Match the pattern to the route and extract template variables.
RouteMatcher.Route	parseRoute(String routeValue) Return a parsed representation of the given route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathPatternRouteMatcher

public PathPatternRouteMatcher()

Default constructor with PathPatternParser customized for MESSAGE_ROUTE and without matching of trailing separator.

PathPatternRouteMatcher

public PathPatternRouteMatcher(PathPatternParser parser)

Constructor with given PathPatternParser.

Method Detail

parseRoute

public RouteMatcher.Route parseRoute(String routeValue)

Description copied from interface: RouteMatcher

Return a parsed representation of the given route.

Specified by:

parseRoute in interface RouteMatcher

Parameters:

routeValue - the route to parse

Returns:

the parsed representation of the route

isPattern

public boolean isPattern(String route)

Description copied from interface: RouteMatcher

Whether the given route contains pattern syntax which requires the RouteMatcher.match(String, Route) method, or if it is a regular String that could be compared directly to others.

Specified by:

isPattern in interface RouteMatcher

Parameters:

route - the route to check

Returns:

true if the given route represents a pattern

combine

public String combine(String pattern1,
                      String pattern2)

Description copied from interface: RouteMatcher

Combines two patterns into a single pattern.

Specified by:

combine in interface RouteMatcher

Parameters:

pattern1 - the first pattern

pattern2 - the second pattern

Returns:

the combination of the two patterns

match

public boolean match(String pattern,
                     RouteMatcher.Route route)

Description copied from interface: RouteMatcher

Match the given route against the given pattern.

Specified by:

match in interface RouteMatcher

Parameters:

pattern - the pattern to try to match

route - the route to test against

Returns:

true if there is a match, false otherwise

matchAndExtract

@Nullable
public Map<String,String> matchAndExtract(String pattern,
                                                    RouteMatcher.Route route)

Description copied from interface: RouteMatcher

Match the pattern to the route and extract template variables.

Specified by:

matchAndExtract in interface RouteMatcher

Parameters:

pattern - the pattern, possibly containing templates variables

route - the route to extract template variables from

Returns:

a map with template variables and values

getPatternComparator

public Comparator<String> getPatternComparator(RouteMatcher.Route route)

Description copied from interface: RouteMatcher

Given a route, return a Comparator suitable for sorting patterns in order of explicitness for that route, so that more specific patterns come before more generic ones.

Specified by:

getPatternComparator in interface RouteMatcher

Parameters:

route - the full path to use for comparison

Returns:

a comparator capable of sorting patterns in order of explicitness