|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.util.AntPathMatcher
public class AntPathMatcher
PathMatcher implementation for Ant-style path patterns. Examples are provided below.
Part of this mapping code has been kindly borrowed from Apache Ant.
The mapping matches URLs using the following rules:
Some examples:
com/t?st.jsp
- matches com/test.jsp
but also
com/tast.jsp
or com/txst.jsp
com/*.jsp
- matches all .jsp
files in the
com
directorycom/**/test.jsp
- matches all test.jsp
files underneath the com
pathorg/springframework/**/*.jsp
- matches all .jsp
files underneath the org/springframework
pathorg/**/servlet/bla.jsp
- matches
org/springframework/servlet/bla.jsp
but also
org/springframework/testing/servlet/bla.jsp
and
org/servlet/bla.jsp
Field Summary | |
---|---|
static String |
DEFAULT_PATH_SEPARATOR
Default path separator: "/" |
Constructor Summary | |
---|---|
AntPathMatcher()
|
Method Summary | |
---|---|
String |
extractPathWithinPattern(String pattern,
String path)
Given a pattern and a full path, determine the pattern-mapped part. |
boolean |
isPattern(String str)
Does the given string represent a pattern that can be matched
by an implementation of this interface? |
boolean |
match(String pattern,
String str)
Match the given text against the given pattern ,
according to this PathMatcher's matching strategy. |
void |
setPathSeparator(String pathSeparator)
Set the path separator to use for pattern parsing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_PATH_SEPARATOR
Constructor Detail |
---|
public AntPathMatcher()
Method Detail |
---|
public void setPathSeparator(String pathSeparator)
public boolean isPattern(String str)
PathMatcher
string
represent a pattern that can be matched
by an implementation of this interface?
If the return value is false
, then the PathMatcher.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.
isPattern
in interface PathMatcher
str
- the string
to check
true
if the given string
represents a patternpublic boolean match(String pattern, String str)
PathMatcher
text
against the given pattern
,
according to this PathMatcher's matching strategy.
match
in interface PathMatcher
pattern
- the pattern to match againststr
- the string to test
true
if the supplied text
matched,
false
if it didn'tpublic String extractPathWithinPattern(String pattern, String 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
'/docs/**\/*.html
' and '/docs/cvs/commit.html
-> 'cvs/commit.html
'/*.html
' and '/docs/cvs/commit.html
-> 'docs/cvs/commit.html
'*.html
' and '/docs/cvs/commit.html
-> '/docs/cvs/commit.html
'*
' and '/docs/cvs/commit.html
-> '/docs/cvs/commit.html
'Assumes that match(java.lang.String, java.lang.String)
returns true
for 'pattern
'
and 'path
', but does not enforce this.
extractPathWithinPattern
in interface PathMatcher
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 |