Field Detail

• public static final String DEFAULT_PATH_SEPARATOR

  Default path separator: "/"

Method Detail

• public String combine(String pattern1, String pattern2)

  Combines two patterns into a new pattern that is returned.

  This implementation simply concatenates the two patterns, unless the first pattern contains a file extension match (such as *.html. In that case, the second pattern should be included in the first, or an IllegalArgumentException is thrown.

  For example:

  Pattern 1	Pattern 2	Result
  /hotels	null	/hotels
  null	/hotels	/hotels
  /hotels	/bookings	/hotels/bookings
  /hotels	bookings	/hotels/bookings
  /hotels/*	/bookings	/hotels/bookings
  /hotels/**	/bookings	/hotels/**/bookings
  /hotels	{hotel}	/hotels/{hotel}
  /hotels/*	{hotel}	/hotels/{hotel}
  /hotels/**	{hotel}	/hotels/**/{hotel}
  /*.html	/hotels.html	/hotels.html
  /*.html	/hotels	/hotels.html
  /*.html	/*.txt	IllegalArgumentException

  throws:

  IllegalArgumentException when the two patterns cannot be combined

  Parameters:

  pattern1 - the first pattern

  pattern2 - the second pattern

  Returns:

  the combination of the two patterns

• public static int countOccurrencesOf(String str, String sub)

  Count the occurrences of the substring in string s.

  Parameters:

  str - string to search in. Return 0 if this is null.

  sub - string to search for. Return 0 if this is null.

• protected boolean doMatch(String pattern, String path, boolean fullMatch, Map<String, String> uriTemplateVariables)

  Actually match the given path against the given pattern.

  Parameters:

  pattern - the pattern to match against

  path - the path String to test

  fullMatch - whether a full pattern match is required (else a pattern match as far as the given base path goes is sufficient)

  Returns:

  true if the supplied path matched, false if it didn't

• public String extractPathWithinPattern(String pattern, String path)

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

  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 returns true for 'pattern' and 'path', but does not enforce this.

• public Map<String, String> extractUriTemplateVariables(String pattern, String path)

• public Comparator<String> getPatternComparator(String path)

  Given a full path, returns a Comparator suitable for sorting patterns in order of explicitness.

  The returned Comparator will {

  linkplain:

  java.util.Collections#sort(java.util.List, java.util.Comparator) sort} a list so that more specific patterns (without uri templates or wild cards) come before generic patterns. So given a list with the following patterns:

  1. /hotels/new
  2. /hotels/{hotel}
  3. /hotels/*

  the returned comparator will sort this list so that the order will be as indicated.

  The full path given as parameter is used to test for exact matches. So when the given path is /hotels/2, the pattern /hotels/2 will be sorted before /hotels/1.

  Parameters:

  path - the full path to use for comparison

  Returns:

  a comparator capable of sorting patterns in order of explicitness

• public boolean isPattern(String path)

• public boolean match(String pattern, String path)

• public boolean matchStart(String pattern, String path)

• public void setPathSeparator(String pathSeparator)

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