UriBuilder (qetcher-client 2.0.3 API)

java.lang.Object
- de.mklinger.qetch.client.common.UriBuilder

```
public class UriBuilder
extends Object
```
URL builder.
Semantics and internal state of this class is modeled after the internals of the URI class, except that only host-based authorities are supported.

Author:

Marc Klinger - mklinger[at]mklinger[dot]de

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UriBuilder`	`absolutePath(boolean absolutePath)` Treat the path as absolute.
`UriBuilder`	`addParameter(String name, boolean value)` Add a parameter to the query.
`UriBuilder`	`addParameter(String name, int value)` Add a parameter to the query.
`UriBuilder`	`addParameter(String name, long value)` Add a parameter to the query.
`UriBuilder`	`addParameter(String name, String value)` Add a parameter to the query.
`UriBuilder`	`addParameters(Map<String,String> parameters)` Add parameters to the query.
`UriBuilder`	`appendRawPath(String path)` Append the given path to the current path.
`URI`	`build()` Get a URI object of this builder.
`UriBuilder`	`fragment(String fragment)` Set the fragment.
`String`	`getFragment()` Get the current fragment string, decoded, without leading '#'.
`String`	`getHost()` Get the host.
`String`	`getHostWithoutPath()`
`Set<String>`	`getParameterNames()` Get all unique parameter names.
`String`	`getParameterValue(String name)` Get the value for the given parameter name.
`List<String>`	`getParameterValues(String name)` Get all parameter values for the given parameter name.
`List<String>`	`getPathComponents()` Get the not URL encoded path components.
`int`	`getPort()` Get the port.
`String`	`getRawFragment()` Get the current fragment string, URL encoded, without leading '#'.
`String`	`getRawPath()` Get the raw, URL-encoded path.
`String`	`getRawQuery()` Get the current query string, URL encoded, without leading '?'.
`String`	`getRawUserInfo()` Get the user info, URL-encoded.
`String`	`getScheme()` Get the scheme.
`UriBuilder`	`host(String host)` Set the host.
`boolean`	`isAbsolutePath()` Return `true` if the path is absolute.
`boolean`	`isRelativePath()` Return `true` if the path is relative.
`static UriBuilder`	`of(String url)` Factory method.
`static UriBuilder`	`of(URI url)` Factory method.
`static UriBuilder`	`of(URL url)` Factory method.
`UriBuilder`	`pathComponent(String path)` Add a path component.
`UriBuilder`	`pathComponents(String... paths)` Add path components.
`UriBuilder`	`port(int port)` Set the port.
`UriBuilder`	`rawFragment(String fragment)` Set the raw fragment.
`UriBuilder`	`rawPath(String path)` Set the raw path.
`UriBuilder`	`rawQuery(String query)` Set the raw query.
`UriBuilder`	`rawUserInfo(String userInfo)` Set the raw user info.
`UriBuilder`	`relativePath(boolean relativePath)` Treat the path as relative.
`UriBuilder`	`removeParameters(String name)` Remove all parameters with the given name.
`UriBuilder`	`scheme(String scheme)` Set the scheme.
`UriBuilder`	`setParameter(String name, boolean value)` Remove all existing parameters with the given name and add a new parameter with given name and value.
`UriBuilder`	`setParameter(String name, int value)` Remove all existing parameters with the given name and add a new parameter with given name and value.
`UriBuilder`	`setParameter(String name, long value)` Remove all existing parameters with the given name and add a new parameter with given name and value.
`UriBuilder`	`setParameter(String name, String value)` Remove all existing parameters with the given name and add a new parameter with given name and value.
`String`	`toString()` Returns the content of the URI built so far as a US-ASCII string.
`URI`	`toUri()` Get a URI object of this builder.
`UriBuilder`	`userInfo(String username, String password)` Set the user info.

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

- Method Detail
  - of
```
public static UriBuilder of(URI url)
```
    Factory method.
  - of
```
public static UriBuilder of(URL url)
```
    Factory method.
  - of
```
public static UriBuilder of(String url)
```
    Factory method.
  - scheme
```
public UriBuilder scheme(String scheme)
```
    Set the scheme.
    
    Parameters:
    
    scheme - The scheme, e.g. "https" - null to not use a scheme in the URL.
  - rawFragment
```
public UriBuilder rawFragment(String fragment)
```
    Set the raw fragment.
    
    Parameters:
    
    fragment - The URL-encoded fragment without leading "#" - null to not use a fragment in the URL
  - fragment
```
public UriBuilder fragment(String fragment)
```
    Set the fragment.
    
    Parameters:
    
    fragment - The non-encoded fragment without leading "#" - null to not use a fragment in the URL
  - rawUserInfo
```
public UriBuilder rawUserInfo(String userInfo)
```
    Set the raw user info.
    
    Parameters:
    
    userInfo - The URL-encoded user info, e.g. "username:password" - null to not use user info in the URL
  - userInfo
```
public UriBuilder userInfo(String username,
                           String password)
```
    Set the user info.
    
    Parameters:
    
    username - The non-URL-encoded username
    
    password - The non-URL-encoded password
  - host
```
public UriBuilder host(String host)
```
    Set the host.
    
    Parameters:
    
    host - The host, e.g. "www.haufe-lexware.com" - null to not use a host in the URL
  - port
```
public UriBuilder port(int port)
```
    Set the port.
    
    Parameters:
    
    port - The port, e.g. 8080 - -1 to not use a port in the URL
  - rawPath
```
public UriBuilder rawPath(String path)
```
    Set the raw path.
    
    Parameters:
    
    path - The URL-encoded path, e.g. "/mypath" - null to not use a path in the URL
  - appendRawPath
```
public UriBuilder appendRawPath(String path)
```
    Append the given path to the current path.
    
    Parameters:
    
    path - The URL-encoded path, e.g. "/mypath".
  - relativePath
```
public UriBuilder relativePath(boolean relativePath)
```
    Treat the path as relative. Relative paths are illegal if a host is set. By default, the path is treated absolute.
  - absolutePath
```
public UriBuilder absolutePath(boolean absolutePath)
```
    Treat the path as absolute. Relative paths are illegal if a host is set. By default, the path is treated absolute.
  - pathComponent
```
public UriBuilder pathComponent(String path)
```
    Add a path component.
    
    Parameters:
    
    path - The path component non-URL-escaped
  - pathComponents
```
public UriBuilder pathComponents(String... paths)
```
    Add path components.
    
    Parameters:
    
    paths - The path components non-URL-escaped
  - rawQuery
```
public UriBuilder rawQuery(String query)
```
    Set the raw query.
    
    Parameters:
    
    query - The URL-encoded query without leading "?", e.g. "key=value&x=y" - null to not use a query in the URL
  - addParameter
```
public UriBuilder addParameter(String name,
                               String value)
```
    Add a parameter to the query. Multiple calls to this method with an equal name will append this parameter multiple times.
    
    Parameters:
    
    name - The parameter key, non-URL-encoded
    
    value - The parameter value, non-URL-encoded, may be null
  - addParameter
```
public UriBuilder addParameter(String name,
                               int value)
```
    Add a parameter to the query. Multiple calls to this method with an equal name will append this parameter multiple times.
    
    Parameters:
    
    name - The parameter key, non-URL-encoded
    
    value - The parameter value
  - addParameter
```
public UriBuilder addParameter(String name,
                               long value)
```
    Add a parameter to the query. Multiple calls to this method with an equal name will append this parameter multiple times.
    
    Parameters:
    
    name - The parameter key, non-URL-encoded
    
    value - The parameter value
  - addParameter
```
public UriBuilder addParameter(String name,
                               boolean value)
```
    Add a parameter to the query. Multiple calls to this method with an equal name will append this parameter multiple times.
    
    Parameters:
    
    name - The parameter key, non-URL-encoded
    
    value - The parameter value
  - addParameters
```
public UriBuilder addParameters(Map<String,String> parameters)
```
    Add parameters to the query.
    
    Parameters:
    
    parameters - A map of non-URL-encoded keys to non-URL-encoded values
  - removeParameters
```
public UriBuilder removeParameters(String name)
```
    Remove all parameters with the given name.
  - setParameter
```
public UriBuilder setParameter(String name,
                               String value)
```
    Remove all existing parameters with the given name and add a new parameter with given name and value.
  - setParameter
```
public UriBuilder setParameter(String name,
                               int value)
```
    Remove all existing parameters with the given name and add a new parameter with given name and value.
  - setParameter
```
public UriBuilder setParameter(String name,
                               long value)
```
    Remove all existing parameters with the given name and add a new parameter with given name and value.
  - setParameter
```
public UriBuilder setParameter(String name,
                               boolean value)
```
    Remove all existing parameters with the given name and add a new parameter with given name and value.
  - getScheme
```
public String getScheme()
```
    Get the scheme.
    
    Returns:
    
    The scheme or null if the scheme is undefined.
  - getRawUserInfo
```
public String getRawUserInfo()
```
    Get the user info, URL-encoded.
    
    Returns:
    
    The user info or null if the user info is undefined
  - getHost
```
public String getHost()
```
    Get the host.
    
    Returns:
    
    the host or null if the host is undefined
  - getPort
```
public int getPort()
```
    Get the port.
    
    Returns:
    
    The port or -1 if the port is undefined.
  - getRawPath
```
public String getRawPath()
```
    Get the raw, URL-encoded path.
    
    Returns:
    
    the path or null if the path is undefined
  - getPathComponents
```
public List<String> getPathComponents()
```
    Get the not URL encoded path components.
    
    Returns:
    
    The path components or an empty list if the path is undefined - never null.
  - isAbsolutePath
```
public boolean isAbsolutePath()
```
    Return true if the path is absolute. In case of an undefined path, the return value of this method is undefined.
    
    Returns:
    
    true if the path is absolute. In case of an undefined path, the return value of this method is undefined.
  - isRelativePath
```
public boolean isRelativePath()
```
    Return true if the path is relative. In case of an undefined path, the return value of this method is undefined.
    
    Returns:
    
    true if the path is relative. In case of an undefined path, the return value of this method is undefined.
  - getFragment
```
public String getFragment()
```
    Get the current fragment string, decoded, without leading '#'.
    
    Returns:
    
    the fragment or null if the fragment is undefined
  - getRawFragment
```
public String getRawFragment()
```
    Get the current fragment string, URL encoded, without leading '#'.
    
    Returns:
    
    the fragment or null if the fragment is undefined
  - getRawQuery
```
public String getRawQuery()
```
    Get the current query string, URL encoded, without leading '?'.
    
    Returns:
    
    the query or null if the query is undefined
  - getParameterValue
```
public String getParameterValue(String name)
```
    Get the value for the given parameter name. If multiple parameters with the given name exist, only the first one is returned. A return value of null may indicate two different things:
    1. There is no such parameter
    2. The first parameter with this name has no value (e.g. a query like "?name")
  - getParameterValues
```
public List<String> getParameterValues(String name)
```
    Get all parameter values for the given parameter name. The list returned is never null, but may contain null values (e.g. for a query like "?name").
  - getParameterNames
```
public Set<String> getParameterNames()
```
    Get all unique parameter names.
    
    Returns:
    
    A set of all parameter names - never null.
  - toUri
```
public URI toUri()
```
    Get a URI object of this builder.
  - build
```
public URI build()
```
    Get a URI object of this builder.
  - toString
```
public String toString()
```
    Returns the content of the URI built so far as a US-ASCII string.
    
    Overrides:
    
    toString in class Object
  - getHostWithoutPath
```
public String getHostWithoutPath()
```

Class UriBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

scheme

rawFragment

fragment

rawUserInfo

userInfo

host

port

rawPath

appendRawPath

relativePath

absolutePath

pathComponent

pathComponents

rawQuery

addParameter

addParameter

addParameter

addParameter

addParameters

removeParameters

setParameter

setParameter

setParameter

setParameter

getScheme

getRawUserInfo

getHost

getPort

getRawPath

getPathComponents

isAbsolutePath

isRelativePath

getFragment

getRawFragment

getRawQuery

getParameterValue

getParameterValues

getParameterNames

toUri

build

toString

getHostWithoutPath