Interface UriTemplate

public interface UriTemplate
A URI template that follows the rfc6570 level 4.

A template is immutable and thread safe, it can be safely shared between threads after its creation. If you are sharing a template as a static variables, keep in mind that of(String) can fail and create a classloading issue.

Author:
Julien Viet

  • Method Details

    • of

      static UriTemplate of(String uri)
      Create a template from a string uri.

      The string uri is validated and parsed, invalid inputs are rejected with a IllegalArgumentException.

      Parameters:
      uri - the template string
      Returns:
      the template
      Throws:
      IllegalArgumentException - when the template

    • expandToString

      String expandToString(Variables variables)
      Expand this template to a string.
      Parameters:
      variables - the variables
      Returns:
      the string expansion of this template with the variables

    • expandToString

      String expandToString(Variables variables, ExpandOptions options)
      Expand this template to a string.
      Parameters:
      variables - the variables
      options - the options to control template expansion
      Returns:
      the string expansion of this template with the variables