Package com.google.gwt.http.client

Class UrlBuilder

java.lang.Object
com.google.gwt.http.client.UrlBuilder
public class UrlBuilder extends Object
Utility class to build a URL from components. TODO(jlabanca): Add a constructor that parses an existing URL

  • Field Details

    • PORT_UNSPECIFIED

      public static final int PORT_UNSPECIFIED
      The port to use when no port should be specified.
      See Also:

  • Constructor Details

    • UrlBuilder

      public UrlBuilder()

  • Method Details

    • buildString

      public String buildString()
      Build the URL and return it as an encoded string.
      Returns:
      the encoded URL string

    • removeParameter

      public UrlBuilder removeParameter(String name)
      Remove a query parameter from the map.
      Parameters:
      name - the parameter name

    • setHash

      public UrlBuilder setHash(String hash)
      Set the hash portion of the location (ex. myAnchor or #myAnchor).
      Parameters:
      hash - the hash

    • setHost

      public UrlBuilder setHost(String host)
      Set the host portion of the location (ex. google.com). You can also specify the port in this method (ex. localhost:8888).
      Parameters:
      host - the host

    • setParameter

      public UrlBuilder setParameter(String key, String... values)

      Set a query parameter to a list of values. Each value in the list will be added as its own key/value pair.

      Example Output

      ?mykey=value0&mykey=value1&mykey=value2

      Parameters:
      key - the key
      values - the list of values

    • setPath

      public UrlBuilder setPath(String path)
      Set the path portion of the location (ex. path/to/file.html).
      Parameters:
      path - the path

    • setPort

      public UrlBuilder setPort(int port)
      Set the port to connect to.
      Parameters:
      port - the port, or PORT_UNSPECIFIED

    • setProtocol

      public UrlBuilder setProtocol(String protocol)
      Set the protocol portion of the location (ex. http).
      Parameters:
      protocol - the protocol