URIBuilder

java.lang.Object
- org.apache.hc.core5.net.URIBuilder

```
public class URIBuilder
extends Object
```
Builder for URI instances.

Since:

5.0

Constructor Summary

Constructors
Constructor and Description
`URIBuilder()` Constructs an empty instance.
`URIBuilder(String string)` Construct an instance from the string which must be a valid URI.
`URIBuilder(String string, java.nio.charset.Charset charset)` Construct an instance from the string which must be a valid URI.
`URIBuilder(URI uri)` Construct an instance from the provided URI.
`URIBuilder(URI uri, java.nio.charset.Charset charset)` Construct an instance from the provided URI.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`URIBuilder`	`addParameter(String param, String value)` Adds parameter to URI query.
`URIBuilder`	`addParameters(List<NameValuePair> nvps)` Adds URI query parameters.
`URI`	`build()` Builds a `URI` instance.
`URIBuilder`	`clearParameters()` Clears URI query parameters.
`java.nio.charset.Charset`	`getCharset()`
`String`	`getFragment()`
`String`	`getHost()`
`String`	`getPath()`
`List<String>`	`getPathSegments()`
`int`	`getPort()`
`List<NameValuePair>`	`getQueryParams()`
`String`	`getScheme()`
`String`	`getUserInfo()`
`boolean`	`isAbsolute()`
`boolean`	`isOpaque()`
`boolean`	`isPathEmpty()`
`boolean`	`isQueryEmpty()`
`static URIBuilder`	`localhost()` Creates a new builder for the host `InetAddress.getLocalHost()`.
`static URIBuilder`	`loopbackAddress()` Creates a new builder for the host `InetAddress.getLoopbackAddress()`.
`URIBuilder`	`removeQuery()` Removes URI query.
`URIBuilder`	`setCharset(java.nio.charset.Charset charset)`
`URIBuilder`	`setCustomQuery(String query)` Sets custom URI query.
`URIBuilder`	`setFragment(String fragment)` Sets URI fragment.
`URIBuilder`	`setHost(InetAddress host)` Sets URI host.
`URIBuilder`	`setHost(String host)` Sets URI host.
`URIBuilder`	`setHttpHost(HttpHost httpHost)` Sets the scheme, host name, and port.
`URIBuilder`	`setParameter(String param, String value)` Sets parameter of URI query overriding existing value if set.
`URIBuilder`	`setParameters(List<NameValuePair> nvps)` Sets URI query parameters.
`URIBuilder`	`setParameters(NameValuePair... nvps)` Sets URI query parameters.
`URIBuilder`	`setPath(String path)` Sets URI path.
`URIBuilder`	`setPathSegments(List<String> pathSegments)` Sets URI path.
`URIBuilder`	`setPathSegments(String... pathSegments)` Sets URI path.
`URIBuilder`	`setPort(int port)` Sets URI port.
`URIBuilder`	`setScheme(String scheme)` Sets URI scheme.
`URIBuilder`	`setUserInfo(String userInfo)` Sets URI user info.
`URIBuilder`	`setUserInfo(String username, String password)` Sets URI user info as a combination of username and password.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - URIBuilder
```
public URIBuilder()
```
    Constructs an empty instance.
  - URIBuilder
```
public URIBuilder(String string)
           throws URISyntaxException
```
    Construct an instance from the string which must be a valid URI.
    
    Parameters:
    
    string - a valid URI in string form
    
    Throws:
    
    URISyntaxException - if the input is not a valid URI
  - URIBuilder
```
public URIBuilder(String string,
                  java.nio.charset.Charset charset)
           throws URISyntaxException
```
    Construct an instance from the string which must be a valid URI.
    
    Parameters:
    
    string - a valid URI in string form
    
    Throws:
    
    URISyntaxException - if the input is not a valid URI
  - URIBuilder
```
public URIBuilder(URI uri)
```
    Construct an instance from the provided URI.
    
    Parameters:
    
    uri -
  - URIBuilder
```
public URIBuilder(URI uri,
                  java.nio.charset.Charset charset)
```
    Construct an instance from the provided URI.
    
    Parameters:
    
    uri -
- Method Detail
  - addParameter
```
public URIBuilder addParameter(String param,
                               String value)
```
    Adds parameter to URI query. The parameter name and value are expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
    
    Returns:
    
    this.
  - addParameters
```
public URIBuilder addParameters(List<NameValuePair> nvps)
```
    Adds URI query parameters. The parameter name / values are expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
    
    Returns:
    
    this.
  - build
```
public URI build()
          throws URISyntaxException
```
    Builds a URI instance.
    
    Throws:
    
    URISyntaxException
  - clearParameters
```
public URIBuilder clearParameters()
```
    Clears URI query parameters.
    
    Returns:
    
    this.
  - getCharset
```
public java.nio.charset.Charset getCharset()
```
  - getFragment
```
public String getFragment()
```
  - getHost
```
public String getHost()
```
  - getPath
```
public String getPath()
```
  - getPathSegments
```
public List<String> getPathSegments()
```
  - getPort
```
public int getPort()
```
  - getQueryParams
```
public List<NameValuePair> getQueryParams()
```
  - getScheme
```
public String getScheme()
```
  - getUserInfo
```
public String getUserInfo()
```
  - isAbsolute
```
public boolean isAbsolute()
```
  - isOpaque
```
public boolean isOpaque()
```
  - isPathEmpty
```
public boolean isPathEmpty()
```
  - isQueryEmpty
```
public boolean isQueryEmpty()
```
  - localhost
```
public static URIBuilder localhost()
                            throws UnknownHostException
```
    Creates a new builder for the host InetAddress.getLocalHost().
    
    Returns:
    
    a new builder.
    
    Throws:
    
    UnknownHostException - if the local host name could not be resolved into an address.
  - loopbackAddress
```
public static URIBuilder loopbackAddress()
```
    Creates a new builder for the host InetAddress.getLoopbackAddress().
  - removeQuery
```
public URIBuilder removeQuery()
```
    Removes URI query.
    
    Returns:
    
    this.
  - setCharset
```
public URIBuilder setCharset(java.nio.charset.Charset charset)
```
  - setCustomQuery
```
public URIBuilder setCustomQuery(String query)
```
    Sets custom URI query. The value is expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove query parameters if present.
    
    Returns:
    
    this.
  - setFragment
```
public URIBuilder setFragment(String fragment)
```
    Sets URI fragment. The value is expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - setHost
```
public URIBuilder setHost(InetAddress host)
```
    Sets URI host.
    
    Returns:
    
    this.
  - setHost
```
public URIBuilder setHost(String host)
```
    Sets URI host.
    
    Returns:
    
    this.
  - setHttpHost
```
public URIBuilder setHttpHost(HttpHost httpHost)
```
    Sets the scheme, host name, and port.
    
    Parameters:
    
    httpHost - the scheme, host name, and port.
    
    Returns:
    
    this.
  - setParameter
```
public URIBuilder setParameter(String param,
                               String value)
```
    Sets parameter of URI query overriding existing value if set. The parameter name and value are expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
    
    Returns:
    
    this.
  - setParameters
```
public URIBuilder setParameters(List<NameValuePair> nvps)
```
    Sets URI query parameters. The parameter name / values are expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
    
    Returns:
    
    this.
  - setParameters
```
public URIBuilder setParameters(NameValuePair... nvps)
```
    Sets URI query parameters. The parameter name / values are expected to be unescaped and may contain non ASCII characters.
    Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
    
    Returns:
    
    this.
  - setPath
```
public URIBuilder setPath(String path)
```
    Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - setPathSegments
```
public URIBuilder setPathSegments(List<String> pathSegments)
```
    Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - setPathSegments
```
public URIBuilder setPathSegments(String... pathSegments)
```
    Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - setPort
```
public URIBuilder setPort(int port)
```
    Sets URI port.
    
    Returns:
    
    this.
  - setScheme
```
public URIBuilder setScheme(String scheme)
```
    Sets URI scheme.
    
    Returns:
    
    this.
  - setUserInfo
```
public URIBuilder setUserInfo(String userInfo)
```
    Sets URI user info. The value is expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - setUserInfo
```
public URIBuilder setUserInfo(String username,
                              String password)
```
    Sets URI user info as a combination of username and password. These values are expected to be unescaped and may contain non ASCII characters.
    
    Returns:
    
    this.
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class URIBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

URIBuilder

URIBuilder

URIBuilder

URIBuilder

URIBuilder

Method Detail

addParameter

addParameters

build

clearParameters

getCharset

getFragment

getHost

getPath

getPathSegments

getPort

getQueryParams

getScheme

getUserInfo

isAbsolute

isOpaque

isPathEmpty

isQueryEmpty

localhost

loopbackAddress

removeQuery

setCharset

setCustomQuery

setFragment

setHost

setHost

setHttpHost

setParameter

setParameters

setParameters

setPath

setPathSegments

setPathSegments

setPort

setScheme

setUserInfo

setUserInfo

toString