okhttp3

Class HttpUrl.Builder

java.lang.Object

okhttp3.HttpUrl.Builder

Enclosing class:

HttpUrl

public static final class HttpUrl.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpUrl.Builder	addEncodedPathSegment(java.lang.String encodedPathSegment)
HttpUrl.Builder	addEncodedPathSegments(java.lang.String encodedPathSegments) Adds a set of encoded path segments separated by a slash (either \ or /).
HttpUrl.Builder	addEncodedQueryParameter(java.lang.String encodedName, java.lang.String encodedValue) Adds the pre-encoded query parameter to this URL's query string.
HttpUrl.Builder	addPathSegment(java.lang.String pathSegment)
HttpUrl.Builder	addPathSegments(java.lang.String pathSegments) Adds a set of path segments separated by a slash (either \ or /).
HttpUrl.Builder	addQueryParameter(java.lang.String name, java.lang.String value) Encodes the query parameter using UTF-8 and adds it to this URL's query string.
HttpUrl	build()
HttpUrl.Builder	encodedFragment(java.lang.String encodedFragment)
HttpUrl.Builder	encodedPassword(java.lang.String encodedPassword)
HttpUrl.Builder	encodedPath(java.lang.String encodedPath)
HttpUrl.Builder	encodedQuery(java.lang.String encodedQuery)
HttpUrl.Builder	encodedUsername(java.lang.String encodedUsername)
HttpUrl.Builder	fragment(java.lang.String fragment)
HttpUrl.Builder	host(java.lang.String host)
HttpUrl.Builder	password(java.lang.String password)
HttpUrl.Builder	port(int port)
HttpUrl.Builder	query(java.lang.String query)
HttpUrl.Builder	removeAllEncodedQueryParameters(java.lang.String encodedName)
HttpUrl.Builder	removeAllQueryParameters(java.lang.String name)
HttpUrl.Builder	removePathSegment(int index)
HttpUrl.Builder	scheme(java.lang.String scheme)
HttpUrl.Builder	setEncodedPathSegment(int index, java.lang.String encodedPathSegment)
HttpUrl.Builder	setEncodedQueryParameter(java.lang.String encodedName, java.lang.String encodedValue)
HttpUrl.Builder	setPathSegment(int index, java.lang.String pathSegment)
HttpUrl.Builder	setQueryParameter(java.lang.String name, java.lang.String value)
java.lang.String	toString()
HttpUrl.Builder	username(java.lang.String username)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

scheme

public HttpUrl.Builder scheme(java.lang.String scheme)

username

public HttpUrl.Builder username(java.lang.String username)

encodedUsername

public HttpUrl.Builder encodedUsername(java.lang.String encodedUsername)

password

public HttpUrl.Builder password(java.lang.String password)

encodedPassword

public HttpUrl.Builder encodedPassword(java.lang.String encodedPassword)

host

public HttpUrl.Builder host(java.lang.String host)

Parameters:

host - either a regular hostname, International Domain Name, IPv4 address, or IPv6 address.

port

public HttpUrl.Builder port(int port)

addPathSegment

public HttpUrl.Builder addPathSegment(java.lang.String pathSegment)

addPathSegments

public HttpUrl.Builder addPathSegments(java.lang.String pathSegments)

Adds a set of path segments separated by a slash (either \ or /). If pathSegments starts with a slash, the resulting URL will have empty path segment.

addEncodedPathSegment

public HttpUrl.Builder addEncodedPathSegment(java.lang.String encodedPathSegment)

addEncodedPathSegments

public HttpUrl.Builder addEncodedPathSegments(java.lang.String encodedPathSegments)

Adds a set of encoded path segments separated by a slash (either \ or /). If encodedPathSegments starts with a slash, the resulting URL will have empty path segment.

setPathSegment

public HttpUrl.Builder setPathSegment(int index,
                                      java.lang.String pathSegment)

setEncodedPathSegment

public HttpUrl.Builder setEncodedPathSegment(int index,
                                             java.lang.String encodedPathSegment)

removePathSegment

public HttpUrl.Builder removePathSegment(int index)

encodedPath

public HttpUrl.Builder encodedPath(java.lang.String encodedPath)

query

public HttpUrl.Builder query(@Nullable
                             java.lang.String query)

encodedQuery

public HttpUrl.Builder encodedQuery(@Nullable
                                    java.lang.String encodedQuery)

addQueryParameter

public HttpUrl.Builder addQueryParameter(java.lang.String name,
                                         @Nullable
                                         java.lang.String value)

Encodes the query parameter using UTF-8 and adds it to this URL's query string.

addEncodedQueryParameter

public HttpUrl.Builder addEncodedQueryParameter(java.lang.String encodedName,
                                                @Nullable
                                                java.lang.String encodedValue)

Adds the pre-encoded query parameter to this URL's query string.

setQueryParameter

public HttpUrl.Builder setQueryParameter(java.lang.String name,
                                         @Nullable
                                         java.lang.String value)

setEncodedQueryParameter

public HttpUrl.Builder setEncodedQueryParameter(java.lang.String encodedName,
                                                @Nullable
                                                java.lang.String encodedValue)

removeAllQueryParameters

public HttpUrl.Builder removeAllQueryParameters(java.lang.String name)

removeAllEncodedQueryParameters

public HttpUrl.Builder removeAllEncodedQueryParameters(java.lang.String encodedName)

fragment

public HttpUrl.Builder fragment(@Nullable
                                java.lang.String fragment)

encodedFragment

public HttpUrl.Builder encodedFragment(@Nullable
                                       java.lang.String encodedFragment)

build

public HttpUrl build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object