|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PathMatcher
Strategy interface for String
-based path matching.
Used by PathMatchingResourcePatternResolver
,
AbstractUrlHandlerMapping
,
PropertiesMethodNameResolver
,
and WebContentInterceptor
.
The default implementation is AntPathMatcher
, supporting the
Ant-style pattern syntax.
AntPathMatcher
Method Summary | |
---|---|
String |
extractPathWithinPattern(String pattern,
String path)
Given a pattern and a full path, determine the pattern-mapped part. |
boolean |
isPattern(String text)
Does the given string represent a pattern that can be matched
by an implementation of this interface? |
boolean |
match(String pattern,
String text)
Match the given text against the given pattern ,
according to this PathMatcher's matching strategy. |
Method Detail |
---|
boolean isPattern(String text)
string
represent a pattern that can be matched
by an implementation of this interface?
If the return value is false
, then the match(java.lang.String, java.lang.String)
method does not have to be used because direct equality comparisons
on the static path Strings will lead to the same result.
text
- the string
to check
true
if the given string
represents a patternboolean match(String pattern, String text)
text
against the given pattern
,
according to this PathMatcher's matching strategy.
pattern
- the pattern to match againsttext
- the string to test
true
if the supplied text
matched,
false
if it didn'tString extractPathWithinPattern(String pattern, String path)
This method is supposed to find out which part of the path is matched dynamically through an actual pattern, that is, it strips off a statically defined leading path from the given full path, returning only the actually pattern-matched part of the path.
For example: For "myroot/*.html" as pattern and "myroot/myfile.html" as full path, this method should return "myfile.html". The detailed determination rules are specified to this PathMatcher's matching strategy.
A simple implementation may return the given full path as-is in case
of an actual pattern, and the empty String in case of the pattern not
containing any dynamic parts (i.e. the pattern
parameter being
a static path that wouldn't qualify as an actual pattern
).
A sophisticated implementation will differentiate between the static parts
and the dynamic parts of the given path pattern.
pattern
- the path patternpath
- the full path to introspect
path
(never null
)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |