Package io.vertx.mutiny.uritemplate

Class UriTemplate

java.lang.Object
io.vertx.mutiny.uritemplate.UriTemplate
All Implemented Interfaces:
MutinyDelegate
public class UriTemplate extends Object implements MutinyDelegate
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.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Julien Viet
See Also:
  • UriTemplate

  • Field Details

  • Constructor Details

    • UriTemplate

      public UriTemplate(io.vertx.uritemplate.UriTemplate delegate)
      Create a new instance of UriTemplate delegating to the given (non-null) instance of UriTemplate.

    • UriTemplate

      public UriTemplate(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.uritemplate.UriTemplate getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • of

      public 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:
      when - the template

    • expandToString

      public 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

      public String expandToString(Variables variables, io.vertx.uritemplate.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

    • newInstance

      public static UriTemplate newInstance(io.vertx.uritemplate.UriTemplate delegate)
      Creates a new instance of the UriTemplate.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object