org.springframework.util
Class PathMatcher

java.lang.Object
  org.springframework.util.PathMatcher

public abstract class PathMatcher

extends java.lang.Object

Utility for matching paths with patterns in an Ant-like way. Examples are provided below.

Part of this mapping code has been kindly borrowed from Apache Ant.

The mapping matches URLs using the following rules:

• ? matches one character
• * matches zero or more characters
• ** matches zero or more 'directories' in a path

Some examples:

• com/t?st.jsp - matches test.jsp but also tast.jsp or txst.jsp
• com/*.jsp - matches all .jsp files in the com directory
• com/**/test.jsp - matches all test.jsp path underneath the com path
• org/springframework/**/*.jsp - matches all .jsp files underneath the org/springframework path
• com/**/servlet/bla.jsp - matches org/springframework/servlet/bla.jsp but also org/springframework/testing/servlet/bla.jsp and com/servlet/bla.jsp

Since:

16.07.2003

Author:

Alef Arendsen, Juergen Hoeller

Constructor Summary

PathMatcher()

Method Summary

static boolean	isPattern(java.lang.String str) Return if the given string represents a pattern to be matched via this class: If not, the "match" method does not have to be used because direct equality comparisons are sufficient.
static boolean	match(java.lang.String pattern, java.lang.String str) Match a string against the given pattern.
static java.util.List	retrieveMatchingFiles(java.lang.String pattern, java.io.File rootDir) Retrieve files that match the given pattern, checking the given directory and its subdirectories.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathMatcher

public PathMatcher()

Method Detail

isPattern

public static boolean isPattern(java.lang.String str)

Return if the given string represents a pattern to be matched via this class: If not, the "match" method does not have to be used because direct equality comparisons are sufficient.

Parameters:

str - the string to check

Returns:

whether the given string represents a pattern

See Also:

match(java.lang.String, java.lang.String)

match

public static boolean match(java.lang.String pattern,
                            java.lang.String str)

Match a string against the given pattern.

Parameters:

pattern - the pattern to match against

str - the string to test

Returns:

whether the arguments matched

retrieveMatchingFiles

public static java.util.List retrieveMatchingFiles(java.lang.String pattern,
                                                   java.io.File rootDir)
                                            throws java.io.IOException

Retrieve files that match the given pattern, checking the given directory and its subdirectories.

Parameters:

pattern - the pattern to match against

rootDir - the directory to start from

Returns:

the List of matching File instances

Throws:

java.io.IOException - if directory contents could not be retrieved