| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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.jspcom/*.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_SEPARATORDefault path separator: "/" | 
| Constructor Summary | |
|---|---|
| AntPathMatcher() | |
| Method Summary | |
|---|---|
| protected  boolean | doMatch(String pattern,
        String path,
        boolean fullMatch)Actually match the given pathagainst the givenpattern. | 
|  String | extractPathWithinPattern(String pattern,
                         String path)Given a pattern and a full path, determine the pattern-mapped part. | 
|  boolean | isPattern(String path)Does the given pathrepresent a pattern that can be matched
 by an implementation of this interface? | 
|  boolean | match(String pattern,
      String path)Match the given pathagainst the givenpattern,
 according to this PathMatcher's matching strategy. | 
|  boolean | matchStart(String pattern,
           String path)Match the given pathagainst the corresponding part of the givenpattern, 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 path)
PathMatcherpath 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 PathMatcherpath - the path String to check
true if the given path represents a pattern
public boolean match(String pattern,
                     String path)
PathMatcherpath against the given pattern,
 according to this PathMatcher's matching strategy.
match in interface PathMatcherpattern - the pattern to match againstpath - the path String to test
true if the supplied path matched,
 false if it didn't
public boolean matchStart(String pattern,
                          String path)
PathMatcherpath against the corresponding part of the given
 pattern, according to this PathMatcher's matching strategy.
 Determines whether the pattern at least matches as far as the given base path goes, assuming that a full path may then match as well.
matchStart in interface PathMatcherpattern - the pattern to match againstpath - the path String to test
true if the supplied path matched,
 false if it didn't
protected boolean doMatch(String pattern,
                          String path,
                          boolean fullMatch)
path against the given pattern.
pattern - the pattern to match againstpath - the path String to testfullMatch - whether a full pattern match is required
 (else a pattern match as far as the given base path goes is sufficient)
true if the supplied path matched,
 false if it didn't
public 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 PathMatcherpattern - the path patternpath - the full path to introspect
path
 (never null)| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||