Skip to content

Commit

Permalink
Polish Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrannen committed Jan 10, 2020
1 parent a31a4f8 commit cb8db1e
Showing 1 changed file with 6 additions and 5 deletions.
Expand Up @@ -614,14 +614,15 @@ else if (path1EndsWithSeparator || path2StartsWithSeparator) {
/**
* Given a full path, returns a {@link Comparator} suitable for sorting patterns in order of
* explicitness.
* <p>This{@code Comparator} will {@linkplain java.util.List#sort(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:
* <p>This {@code Comparator} will {@linkplain java.util.List#sort(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, the returned comparator
* will sort this list so that the order will be as indicated.
* <ol>
* <li>{@code /hotels/new}</li>
* <li>{@code /hotels/{hotel}}</li> <li>{@code /hotels/*}</li>
* <li>{@code /hotels/{hotel}}</li>
* <li>{@code /hotels/*}</li>
* </ol>
* the returned comparator will sort this list so that the order will be as indicated.
* <p>The full path given as parameter is used to test for exact matches. So when the given path
* is {@code /hotels/2}, the pattern {@code /hotels/2} will be sorted before {@code /hotels/1}.
* @param path the full path to use for comparison
Expand Down

0 comments on commit cb8db1e

Please sign in to comment.