Apache HttpClient 4.5.14 · org.apache.http.client.utils.URIBuilder

Field Summary

Modifier and Type	Field and Description
private Charset	charset
private String	encodedAuthority
private String	encodedFragment
private String	encodedPath
private String	encodedQuery
private String	encodedSchemeSpecificPart
private String	encodedUserInfo
private String	fragment
private String	host
private List<String>	pathSegments
private int	port
private String	query
private List<NameValuePair>	queryParams
private String	scheme
private String	userInfo

Constructor Summary

Access	Constructor and Description
public	URIBuilder() Constructs an empty instance.
public	URIBuilder(final String a valid URI in string form string) Construct an instance from the string which must be a valid URI.
public	URIBuilder(final URI uri) Construct an instance from the provided URI.
public	URIBuilder(final String a valid URI in string form string, final Charset charset) Construct an instance from the string which must be a valid URI.
public	URIBuilder(final URI uri, final Charset charset) Construct an instance from the provided URI.

Method Summary

Modifier and Type	Method and Description
public URIBuilder	addParameter(final String param, final String value) Adds parameter to URI query.
public URIBuilder	addParameters(final List<NameValuePair> nvps) Adds URI query parameters.
public URI	build() Builds a `URI` instance.
private String	buildString()
public URIBuilder	clearParameters() Clears URI query parameters.
private void	digestURI(final URI uri)
private String	encodePath(final List<String> pathSegments)
private String	encodeUric(final String fragment)
private String	encodeUrlForm(final List<NameValuePair> params)
private String	encodeUserInfo(final String userInfo)
public Charset	getCharset()
public String	getFragment()
public String	getHost()
public String	getPath()
public List<String>	getPathSegments()
public int	getPort()
public List<NameValuePair>	getQueryParams()
public String	getScheme()
public String	getUserInfo()
public boolean	isAbsolute()
public boolean	isOpaque()
public boolean	isPathEmpty()
public boolean	isQueryEmpty()
private static String	normalizePath(final String path, final boolean relative)
private List<String>	parsePath(final String path, final Charset charset)
private List<NameValuePair>	parseQuery(final String query, final Charset charset)
public URIBuilder	removeQuery() Removes URI query.
public URIBuilder	setCharset(final Charset charset)
public URIBuilder	setCustomQuery(final String query) Sets custom URI query.
public URIBuilder	setFragment(final String fragment) Sets URI fragment.
public URIBuilder	setHost(final String host) Sets URI host.
public URIBuilder	setParameter(final String param, final String value) Sets parameter of URI query overriding existing value if set.
public URIBuilder	setParameters(final List<NameValuePair> nvps) Sets URI query parameters.
public URIBuilder	setParameters(final NameValuePair... nvps) Sets URI query parameters.
public URIBuilder	Returns: this. setPath(final String path) Sets URI path.
public URIBuilder	Returns: this. setPathSegments(final String... pathSegments) Sets URI path.
public URIBuilder	Returns: this. setPathSegments(final List<String> pathSegments) Sets URI path.
public URIBuilder	setPort(final int port) Sets URI port.
public URIBuilder	setQuery(final String query) Deprecated (4.3) use `setParameters(List)` or `setParameters(NameValuePair...)` Sets URI query.
public URIBuilder	setScheme(final String scheme) Sets URI scheme.
public URIBuilder	setUserInfo(final String userInfo) Sets URI user info.
public URIBuilder	setUserInfo(final String username, final String password) Sets URI user info as a combination of username and password.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

charset	back to summary
private Charset charset

encodedAuthority	back to summary
private String encodedAuthority

encodedFragment	back to summary
private String encodedFragment

encodedPath	back to summary
private String encodedPath

encodedQuery	back to summary
private String encodedQuery

encodedSchemeSpecificPart	back to summary
private String encodedSchemeSpecificPart

encodedUserInfo	back to summary
private String encodedUserInfo

fragment	back to summary
private String fragment

host	back to summary
private String host

pathSegments	back to summary
private List<String> pathSegments

port	back to summary
private int port

query	back to summary
private String query

queryParams	back to summary
private List<NameValuePair> queryParams

scheme	back to summary
private String scheme

userInfo	back to summary
private String userInfo

Constructor Detail

URIBuilder	back to summary
public URIBuilder() Constructs an empty instance.

URIBuilder	back to summary
public URIBuilder(final String string) throws URISyntaxException Construct an instance from the string which must be a valid URI. Parameters string:String a valid URI in string form Exceptions URISyntaxException: if the input is not a valid URI

URIBuilder

back to summary

public URIBuilder(final String string) throws URISyntaxException

Construct an instance from the string which must be a valid URI.

Parameters

string:String: a valid URI in string form

Exceptions

URISyntaxException:: if the input is not a valid URI

URIBuilder	back to summary
public URIBuilder(final URI uri) Construct an instance from the provided URI.

URIBuilder	back to summary
public URIBuilder(final String string, final Charset charset) throws URISyntaxException Construct an instance from the string which must be a valid URI. Parameters string:String a valid URI in string form Exceptions URISyntaxException: if the input is not a valid URI

URIBuilder

back to summary

public URIBuilder(final String string, final Charset charset) throws URISyntaxException

Construct an instance from the string which must be a valid URI.

Parameters

string:String: a valid URI in string form

Exceptions

URISyntaxException:: if the input is not a valid URI

URIBuilder	back to summary
public URIBuilder(final URI uri, final Charset charset) Construct an instance from the provided URI.

Method Detail

addParameter	back to summary
public URIBuilder addParameter(final String param, final 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.

addParameter

back to summary

public URIBuilder addParameter(final String param, final 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.

addParameters	back to summary
public URIBuilder addParameters(final 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. Since 4.3

addParameters

back to summary

public URIBuilder addParameters(final 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.

Since: 4.3

build	back to summary
public URI build() throws URISyntaxException Builds a `URI` instance.

buildString	back to summary
private String buildString()

clearParameters	back to summary
public URIBuilder clearParameters() Clears URI query parameters. Since 4.3

clearParameters

back to summary

public URIBuilder clearParameters()

Clears URI query parameters.

Since: 4.3

digestURI	back to summary
private void digestURI(final URI uri)

encodePath	back to summary
private String encodePath(final List<String> pathSegments)

encodeUric	back to summary
private String encodeUric(final String fragment)

encodeUrlForm	back to summary
private String encodeUrlForm(final List<NameValuePair> params)

encodeUserInfo	back to summary
private String encodeUserInfo(final String userInfo)

getCharset	back to summary
public Charset getCharset() Since 4.4

getFragment	back to summary
public String getFragment()

getHost	back to summary
public String getHost()

getPath	back to summary
public String getPath()

getPathSegments	back to summary
public List<String> getPathSegments() Since 4.5.8

getPort	back to summary
public int getPort()

getQueryParams	back to summary
public List<NameValuePair> getQueryParams()

getScheme	back to summary
public String getScheme()

getUserInfo	back to summary
public String getUserInfo()

isAbsolute	back to summary
public boolean isAbsolute() Since 4.3

isOpaque	back to summary
public boolean isOpaque() Since 4.3

isPathEmpty	back to summary
public boolean isPathEmpty() Since 4.5.8

isQueryEmpty	back to summary
public boolean isQueryEmpty() Since 4.5.8

normalizePath	back to summary
private static String normalizePath(final String path, final boolean relative)

parsePath	back to summary
private List<String> parsePath(final String path, final Charset charset)

parseQuery	back to summary
private List<NameValuePair> parseQuery(final String query, final Charset charset)

removeQuery	back to summary
public URIBuilder removeQuery() Removes URI query.

setCharset	back to summary
public URIBuilder setCharset(final Charset charset) Since 4.4

setCustomQuery

back to summary

public URIBuilder setCustomQuery(final 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.

Since: 4.3

setFragment	back to summary
public URIBuilder setFragment(final String fragment) Sets URI fragment. The value is expected to be unescaped and may contain non ASCII characters.

setHost	back to summary
public URIBuilder setHost(final String host) Sets URI host.

setParameter

back to summary

public URIBuilder setParameter(final String param, final 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.

setParameters

back to summary

public URIBuilder setParameters(final 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.

Since: 4.3

setParameters

back to summary

public URIBuilder setParameters(final 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.

Since: 4.3

setPath

back to summary

public URIBuilder setPath(final String path)

Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.

Returns:URIBuilder: this.

setPathSegments

back to summary

public URIBuilder setPathSegments(final String... pathSegments)

Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.

Returns:URIBuilder: this.
Since: 4.5.8

setPathSegments

back to summary

public URIBuilder setPathSegments(final List<String> pathSegments)

Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.

Returns:URIBuilder: this.
Since: 4.5.8

setPort	back to summary
public URIBuilder setPort(final int port) Sets URI port.

setQuery back to summary

public URIBuilder setQuery(final String query)

Deprecated

(4.3) use setParameters(List) or setParameters(NameValuePair...)

Sets URI query.

The value is expected to be encoded form data.

Annotations

@Deprecated

See Also

URLEncodedUtils#parse

setScheme	back to summary
public URIBuilder setScheme(final String scheme) Sets URI scheme.

setUserInfo	back to summary
public URIBuilder setUserInfo(final String userInfo) Sets URI user info. The value is expected to be unescaped and may contain non ASCII characters.

setUserInfo	back to summary
public URIBuilder setUserInfo(final String username, final 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.