com.sun.jersey.spi.uri.rules
Interface UriRules<R>


public interface UriRules<R>

A collection of URI rules that can be matched using associated patterns.

The precedence of the rules and the type of patterns is specified by an implementation of this interface.


Method Summary
 java.util.Iterator<R> match(java.lang.CharSequence path, java.util.List<java.lang.String> capturingGroupValues)
          Match a URI path to the collection of rules and iterate over the matching rules.
 

Method Detail

match

java.util.Iterator<R> match(java.lang.CharSequence path,
                            java.util.List<java.lang.String> capturingGroupValues)
Match a URI path to the collection of rules and iterate over the matching rules.

Parameters:
path - the URI path to be matched
capturingGroupValues - the list to store the values of a pattern's capturing groups. This list will be cleared and modified each time Iterator.next() is called according to the pattern associated with the returned rule. The values are stored in the same order as the pattern's capturing groups.
Returns:
an iterator of matching rules