io.muserver.rest

Class UriPattern

java.lang.Object

io.muserver.rest.UriPattern

public class UriPattern
extends Object

A pattern representing a URI template, such as /fruit or /fruit/{name} etc. To create a new pattern, call the static uriTemplateToRegex(String) method.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
PathMatch	matcher(String rawPath) Matches the given raw path against this pattern.
PathMatch	matcher(URI input) Matches the given URI against this pattern.
List<String>	namedGroups()
String	pattern()
String	toString()
static UriPattern	uriTemplateToRegex(String template) Converts a URI Template to a regular expression, following the JAX-RS: Java™ API for RESTful Web Services specification Version 2.0 section 3.7.3

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

pattern

public String pattern()

Returns:

Returns the regular expression used to do the matching

namedGroups

public List<String> namedGroups()

Returns:

Returns the read-only set of path parameters in this pattern in the order they first appeared

matcher

public PathMatch matcher(URI input)

Matches the given URI against this pattern.

Parameters:

input - The URI to check against.

Returns:

Returns a PathMatch where PathMatch.prefixMatches() is true if the URI matches and otherwise false.

matcher

public PathMatch matcher(String rawPath)

Matches the given raw path against this pattern.

Parameters:

rawPath - The URL-encoded path to match, for example /example/some%20path

Returns:

Returns a PathMatch where PathMatch.prefixMatches() is true if the URI matches and otherwise false.

toString

public String toString()

Overrides:

toString in class Object

uriTemplateToRegex

public static UriPattern uriTemplateToRegex(String template)
                                     throws IllegalArgumentException

Converts a URI Template to a regular expression, following the JAX-RS: Java™ API for RESTful Web Services specification Version 2.0 section 3.7.3

Parameters:

template - A string as passed to a Path annotation, such as /fruit/{name}

Returns:

Returns a compiled regex Pattern for the given template that will match relevant URI paths, for example /\Qfruit\E/(?<name>[ˆ/]+?)(/.*)?

Throws:

IllegalArgumentException - If the template contains invalid regular expression, or template is null, or other errors

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object