AntPathMatcher (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.util
Class AntPathMatcher

java.lang.Object
  org.springframework.util.AntPathMatcher

All Implemented Interfaces:: PathMatcher

public class AntPathMatcher
extends Object
implements PathMatcher
extends Object
implements PathMatcher

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:

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

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 directory
com/**/test.jsp - matches all test.jsp files underneath the com path
org/springframework/**/*.jsp - matches all .jsp files underneath the org/springframework path
org/**/servlet/bla.jsp - matches org/springframework/servlet/bla.jsp but also org/springframework/testing/servlet/bla.jsp and org/servlet/bla.jsp

Since:: 16.07.2003
Author:: Alef Arendsen, Juergen Hoeller, Rob Harrop

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 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

DEFAULT_PATH_SEPARATOR

public static final String DEFAULT_PATH_SEPARATOR

Default path separator: "/"

See Also:: Constant Field Values

Constructor Detail

AntPathMatcher

public AntPathMatcher()

Method Detail

setPathSeparator

public void setPathSeparator(String pathSeparator)

Set the path separator to use for pattern parsing. Default is "/", as in Ant.

isPattern

public boolean isPattern(String str)

Description copied from interface: PathMatcher

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 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.

Specified by:: isPattern in interface PathMatcher

Parameters:: str - the string to check
Returns:: true if the given string represents a pattern

match

public boolean match(String pattern,
                     String str)