Class UrlBuilder

java.lang.Object
com.azure.core.util.UrlBuilder

public final class UrlBuilder extends Object
A builder class that is used to create URLs.
  • Constructor Details

    • UrlBuilder

      public UrlBuilder()
  • Method Details

    • setScheme

      public UrlBuilder setScheme(String scheme)
      Set the scheme/protocol that will be used to build the final URL.
      Parameters:
      scheme - The scheme/protocol that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • getScheme

      public String getScheme()
      Get the scheme/protocol that has been assigned to this UrlBuilder.
      Returns:
      the scheme/protocol that has been assigned to this UrlBuilder.
    • setHost

      public UrlBuilder setHost(String host)
      Set the host that will be used to build the final URL.
      Parameters:
      host - The host that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • getHost

      public String getHost()
      Get the host that has been assigned to this UrlBuilder.
      Returns:
      the host that has been assigned to this UrlBuilder.
    • setPort

      public UrlBuilder setPort(String port)
      Set the port that will be used to build the final URL.
      Parameters:
      port - The port that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • setPort

      public UrlBuilder setPort(int port)
      Set the port that will be used to build the final URL.
      Parameters:
      port - The port that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • getPort

      public Integer getPort()
      Get the port that has been assigned to this UrlBuilder.
      Returns:
      the port that has been assigned to this UrlBuilder.
    • setPath

      public UrlBuilder setPath(String path)
      Set the path that will be used to build the final URL.
      Parameters:
      path - The path that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • getPath

      public String getPath()
      Get the path that has been assigned to this UrlBuilder.
      Returns:
      the path that has been assigned to this UrlBuilder.
    • setQueryParameter

      public UrlBuilder setQueryParameter(String queryParameterName, String queryParameterEncodedValue)
      Set the provided query parameter name and encoded value to query string for the final URL.
      Parameters:
      queryParameterName - The name of the query parameter.
      queryParameterEncodedValue - The encoded value of the query parameter.
      Returns:
      The provided query parameter name and encoded value to query string for the final URL.
      Throws:
      NullPointerException - if queryParameterName or queryParameterEncodedValue are null.
    • addQueryParameter

      public UrlBuilder addQueryParameter(String queryParameterName, String queryParameterEncodedValue)
      Append the provided query parameter name and encoded value to query string for the final URL.
      Parameters:
      queryParameterName - The name of the query parameter.
      queryParameterEncodedValue - The encoded value of the query parameter.
      Returns:
      The provided query parameter name and encoded value to query string for the final URL.
      Throws:
      NullPointerException - if queryParameterName or queryParameterEncodedValue are null.
    • setQuery

      public UrlBuilder setQuery(String query)
      Set the query that will be used to build the final URL.
      Parameters:
      query - The query that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • clearQuery

      public UrlBuilder clearQuery()
      Clear the query that will be used to build the final URL.
      Returns:
      This UrlBuilder so that multiple setters can be chained together.
    • getQuery

      public Map<String,String> getQuery()
      Get the query that has been assigned to this UrlBuilder.
      Returns:
      the query that has been assigned to this UrlBuilder.
    • getQueryString

      public String getQueryString()
      Returns the query string currently configured in this UrlBuilder instance.
      Returns:
      A String containing the currently configured query string.
    • toUrl

      public URL toUrl() throws MalformedURLException
      Get the URL that is being built.
      Returns:
      The URL that is being built.
      Throws:
      MalformedURLException - if the URL is not fully formed.
    • toString

      public String toString()
      Get the string representation of the URL that is being built.
      Overrides:
      toString in class Object
      Returns:
      The string representation of the URL that is being built.
    • parse

      public static UrlBuilder parse(String url)
      Parses the passed url string into a UrlBuilder.
      Parameters:
      url - The URL string to parse.
      Returns:
      The UrlBuilder that was created from parsing the passed URL string.
    • parse

      public static UrlBuilder parse(URL url)
      Parse a UrlBuilder from the provided URL object.
      Parameters:
      url - The URL object to parse.
      Returns:
      The UrlBuilder that was parsed from the URL object.