public class UriTemplate extends Object implements Serializable
expand(Map)
, expand(Object[])
, or matched to a URL via
match(String)
. This class is designed to be thread-safe and
reusable, and allows any number of expand or match calls.
Note: this class uses UriComponentsBuilder
internally to expand URI templates, and is merely a shortcut for already
prepared URI templates. For more dynamic preparation and extra flexibility,
e.g. around URI encoding, consider using UriComponentsBuilder
or the
higher level DefaultUriBuilderFactory
which adds several encoding
modes on top of UriComponentsBuilder
. See the
reference docs
for further details.
Constructor and Description |
---|
UriTemplate(String uriTemplate)
Construct a new
UriTemplate with the given URI String. |
Modifier and Type | Method and Description |
---|---|
URI |
expand(Map<String,?> uriVariables)
Given the Map of variables, expands this template into a URI.
|
URI |
expand(Object... uriVariableValues)
Given an array of variables, expand this template into a full URI.
|
List<String> |
getVariableNames()
Return the names of the variables in the template, in order.
|
Map<String,String> |
match(String uri)
Match the given URI to a map of variable values.
|
boolean |
matches(String uri)
Indicate whether the given URI matches this template.
|
String |
toString() |
public UriTemplate(String uriTemplate)
UriTemplate
with the given URI String.uriTemplate
- the URI template stringpublic List<String> getVariableNames()
public URI expand(Map<String,?> uriVariables)
Example:
UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}"); Map<String, String> uriVariables = new HashMap<String, String>(); uriVariables.put("booking", "42"); uriVariables.put("hotel", "Rest & Relax"); System.out.println(template.expand(uriVariables));will print:
https://example.com/hotels/Rest%20%26%20Relax/bookings/42
uriVariables
- the map of URI variablesIllegalArgumentException
- if uriVariables
is null
;
or if it does not contain values for all the variable namespublic URI expand(Object... uriVariableValues)
Example:
UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}"); System.out.println(template.expand("Rest & Relax", 42));will print:
https://example.com/hotels/Rest%20%26%20Relax/bookings/42
uriVariableValues
- the array of URI variablesIllegalArgumentException
- if uriVariables
is null
or if it does not contain sufficient variablespublic boolean matches(@Nullable String uri)
uri
- the URI to match totrue
if it matches; false
otherwisepublic Map<String,String> match(String uri)
Example:
UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}"); System.out.println(template.match("https://example.com/hotels/1/bookings/42"));will print:
{hotel=1, booking=42}
uri
- the URI to match to