io.muserver.rest

Class PathMatch

java.lang.Object

io.muserver.rest.PathMatch

public class PathMatch
extends Object

The result of matching a template URI against a real request URI. If there is a match, then any path parameters are available in the params() map.

Field Summary

Fields

Modifier and Type	Field and Description
static PathMatch	EMPTY_MATCH

Method Summary

Modifier and Type	Method and Description
boolean	fullyMatches()
Map<String,String>	params() Returns a mapping of URI names to path params.
boolean	prefixMatches()
Matcher	regexMatcher()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_MATCH

public static final PathMatch EMPTY_MATCH

Method Detail

prefixMatches

public boolean prefixMatches()

Returns:

Returns true if the beginning of the checked URI matches this pattern. For example if the pattern is /abc then this will return true for /abc and /abc/def etc.

fullyMatches

public boolean fullyMatches()

Returns:

Returns true if the checked URI matches this pattern. For example if the pattern is /abc then this will return true for /abc but false for /abc/def etc.

params

public Map<String,String> params()

Returns a mapping of URI names to path params. For example the the template URI is /fruit/{name} then pathMatch.params().get("name") will return orange if the URI was /fruit/orange

Returns:

Returns a read-only map of path parameters names to values.

regexMatcher

public Matcher regexMatcher()

Returns:

Returns the regex Matcher that was used

toString

public String toString()

Overrides:

toString in class Object