org.schabi.newpipe.extractor.downloader

Class Request.Builder

java.lang.Object

org.schabi.newpipe.extractor.downloader.Request.Builder

Enclosing class:

Request

public static final class Request.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Request.Builder	addHeader(String headerName, String headerValue)
Request.Builder	addHeaders(String headerName, List<String> headerValueList)
Request.Builder	automaticLocalizationHeader(boolean automaticLocalizationHeaderToSet) If localization headers should automatically be included in the request.
Request	build()
Request.Builder	dataToSend(byte[] dataToSendToSet) An optional byte array that will be sent when doing the request, very commonly used in POST requests. The implementation should make note of some recommended headers (for example, Content-Length in a post request).
Request.Builder	get(String urlToSet)
Request.Builder	head(String urlToSet)
Request.Builder	headers(Map<String,List<String>> headersToSet) A list of headers that will be used in the request. Any default headers that the implementation may have, should be overridden by these.
Request.Builder	httpMethod(String httpMethodToSet) A http method (i.e.
Request.Builder	localization(Localization localizationToSet) A localization object that should be used when executing a request. Usually the Accept-Language will be set to this value (a helper method to do this easily: Request.headersFromLocalization(Localization)).
Request.Builder	post(String urlToSet, byte[] dataToSendToSet)
Request.Builder	setHeader(String headerName, String headerValue)
Request.Builder	setHeaders(String headerName, List<String> headerValueList)
Request.Builder	url(String urlToSet) The URL that is pointing to the wanted resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

httpMethod

public Request.Builder httpMethod(String httpMethodToSet)

A http method (i.e. GET, POST, HEAD).

url

public Request.Builder url(String urlToSet)

The URL that is pointing to the wanted resource.

headers

public Request.Builder headers(@Nullable
                               Map<String,List<String>> headersToSet)

A list of headers that will be used in the request.
Any default headers that the implementation may have, should be overridden by these.

dataToSend

public Request.Builder dataToSend(byte[] dataToSendToSet)

An optional byte array that will be sent when doing the request, very commonly used in POST requests.

The implementation should make note of some recommended headers (for example, Content-Length in a post request).

localization

public Request.Builder localization(Localization localizationToSet)

A localization object that should be used when executing a request.

Usually the Accept-Language will be set to this value (a helper method to do this easily: Request.headersFromLocalization(Localization)).

automaticLocalizationHeader

public Request.Builder automaticLocalizationHeader(boolean automaticLocalizationHeaderToSet)

If localization headers should automatically be included in the request.

build

public Request build()

get

public Request.Builder get(String urlToSet)

head

public Request.Builder head(String urlToSet)

post

public Request.Builder post(String urlToSet,
                            @Nullable
                            byte[] dataToSendToSet)

setHeaders

public Request.Builder setHeaders(String headerName,
                                  List<String> headerValueList)

addHeaders

public Request.Builder addHeaders(String headerName,
                                  List<String> headerValueList)

setHeader

public Request.Builder setHeader(String headerName,
                                 String headerValue)

addHeader

public Request.Builder addHeader(String headerName,
                                 String headerValue)