org.springframework.util
Interface PathMatcher

All Known Implementing Classes:

AntPathMatcher

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.

Since:

1.2

Author:

Juergen Hoeller

See Also:

AntPathMatcher

Method Summary

String	extractPathWithinPattern(String pattern, String path) Given a pattern and a full path, returns the non-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.

Method Detail

isPattern

boolean isPattern(String text)

Does the given 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 will be sufficient.

Parameters:

text - the string to check

Returns:

true if the given string represents a pattern

match

boolean match(String pattern,
              String text)

Match the given text against the given pattern.

Parameters:

pattern - the pattern to match against

text - the string to test

Returns:

true if the supplied text matched

extractPathWithinPattern

String extractPathWithinPattern(String pattern,
                                String path)

Given a pattern and a full path, returns the non-pattern mapped part.

Parameters:

pattern - the path pattern

path - the full path

Returns:

the non-pattern mapped part of the given path