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,
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,
Charset charset)
Construct an instance from the provided URI.
|
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.
|
URIBuilder |
appendPath(String path)
Appends path to URI.
|
URIBuilder |
appendPathSegments(List<String> pathSegments)
Appends segments to URI path.
|
URIBuilder |
appendPathSegments(String... pathSegments)
Appends segments URI path.
|
URI |
build()
Builds a
URI instance. |
URIBuilder |
clearParameters()
Clears URI query parameters.
|
Charset |
getCharset() |
String |
getFragment() |
String |
getHost()
Gets the host portion of the
URI . |
String |
getPath() |
List<String> |
getPathSegments() |
int |
getPort() |
List<NameValuePair> |
getQueryParams() |
String |
getScheme() |
String |
getSchemeSpecificPart()
Gets the scheme specific part
|
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 |
normalizeSyntax()
Normalizes syntax of URI components if the URI is considered non-opaque
(the path component has a root):
characters of scheme and host components are converted to lower case
dot segments of the path component are removed if the path has a root
percent encoding of all components is normalized
|
URIBuilder |
removeQuery()
Removes URI query.
|
URIBuilder |
setCharset(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 |
setPathSegmentsRootless(List<String> pathSegments)
Sets rootless URI path (the first segment does not start with a /).
|
URIBuilder |
setPathSegmentsRootless(String... pathSegments)
Sets rootless URI path (the first segment does not start with a /).
|
URIBuilder |
setPort(int port)
Sets URI port.
|
URIBuilder |
setScheme(String scheme)
Sets URI scheme.
|
URIBuilder |
setSchemeSpecificPart(String schemeSpecificPart)
Sets the URI scheme specific part.
|
URIBuilder |
setSchemeSpecificPart(String schemeSpecificPart,
List<NameValuePair> nvps)
Sets the URI scheme specific part and append a list of NameValuePair to this part.
|
URIBuilder |
setSchemeSpecificPart(String schemeSpecificPart,
NameValuePair... nvps)
Sets the URI scheme specific part and append a variable arguments list of NameValuePair instance(s) to this part.
|
URIBuilder |
setUserInfo(String userInfo)
Sets URI user info.
|
URIBuilder |
setUserInfo(String username,
String password)
Deprecated.
The use of clear-text passwords in
URI s has been deprecated and is strongly
discouraged. |
String |
toString() |
public URIBuilder()
public URIBuilder(String string) throws URISyntaxException
string
- a valid URI in string formURISyntaxException
- if the input is not a valid URIpublic URIBuilder(URI uri)
uri
- public URIBuilder(String string, Charset charset) throws URISyntaxException
string
- a valid URI in string formURISyntaxException
- if the input is not a valid URIpublic static URIBuilder localhost() throws UnknownHostException
InetAddress.getLocalHost()
.UnknownHostException
- if the local host name could not be resolved into an address.public static URIBuilder loopbackAddress()
InetAddress.getLoopbackAddress()
.public URIBuilder setCharset(Charset charset)
public Charset getCharset()
public URI build() throws URISyntaxException
URI
instance.URISyntaxException
public URIBuilder setScheme(String scheme)
public URIBuilder setSchemeSpecificPart(String schemeSpecificPart)
schemeSpecificPart
- public URIBuilder setSchemeSpecificPart(String schemeSpecificPart, NameValuePair... nvps)
schemeSpecificPart
- nvps
- Optional, can be null. Variable arguments list of NameValuePair query parameters to be reused by the specific scheme partpublic URIBuilder setSchemeSpecificPart(String schemeSpecificPart, List<NameValuePair> nvps)
schemeSpecificPart
- nvps
- Optional, can be null. List of query parameters to be reused by the specific scheme partpublic URIBuilder setUserInfo(String userInfo)
@Deprecated public URIBuilder setUserInfo(String username, String password)
URI
s has been deprecated and is strongly
discouraged.public URIBuilder setHost(InetAddress host)
public URIBuilder setHost(String host)
::1
is valid however
[::1]
is not. It is dangerous to call uriBuilder.setHost(uri.getHost())
due
to URI.getHost()
returning URI encoded values.public URIBuilder setHttpHost(HttpHost httpHost)
httpHost
- the scheme, host name, and port.public URIBuilder setPort(int port)
public URIBuilder setPath(String path)
public URIBuilder appendPath(String path)
public URIBuilder setPathSegments(String... pathSegments)
public URIBuilder appendPathSegments(String... pathSegments)
public URIBuilder setPathSegmentsRootless(String... pathSegments)
public URIBuilder setPathSegments(List<String> pathSegments)
public URIBuilder appendPathSegments(List<String> pathSegments)
public URIBuilder setPathSegmentsRootless(List<String> pathSegments)
public URIBuilder removeQuery()
public URIBuilder setParameters(List<NameValuePair> nvps)
Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
public URIBuilder addParameters(List<NameValuePair> nvps)
Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
public URIBuilder setParameters(NameValuePair... nvps)
Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
public URIBuilder addParameter(String param, String value)
Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
public URIBuilder setParameter(String param, String value)
Please note query parameters and custom query component are mutually exclusive. This method will remove custom query if present.
public URIBuilder clearParameters()
public URIBuilder setCustomQuery(String query)
Please note query parameters and custom query component are mutually exclusive. This method will remove query parameters if present.
public URIBuilder setFragment(String fragment)
public boolean isAbsolute()
public boolean isOpaque()
public String getScheme()
public String getSchemeSpecificPart()
public String getUserInfo()
public String getHost()
URI
. This method returns unencoded IPv6 addresses (without brackets).
This behavior differs from values returned by URI.getHost()
.public int getPort()
public boolean isPathEmpty()
public String getPath()
public boolean isQueryEmpty()
public List<NameValuePair> getQueryParams()
public String getFragment()
public URIBuilder normalizeSyntax()
Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.