模块 okhttps

程序包 com.ejlchina.okhttps.okhttp

类 OkHttpBuilderImpl

java.lang.Object

com.ejlchina.okhttps.okhttp.OkHttpBuilderImpl

所有已实现的接口:

HTTP.Builder

public class OkHttpBuilderImpl
extends Object
implements HTTP.Builder

构造器概要

构造器

构造器	说明
OkHttpBuilderImpl()
OkHttpBuilderImpl(OkHttpClientWrapper hc)

方法概要

修饰符和类型	方法	说明
HTTP.Builder	addMsgConvertor(MsgConvertor msgConvertor)
HTTP.Builder	addPreprocessor(Preprocessor preprocessor)	添加可并行处理请求任务的预处理器
HTTP.Builder	addSerialPreprocessor(Preprocessor preprocessor)	添加串行预处理器
String	baseUrl()
HTTP.Builder	baseUrl(String baseUrl)	设置 baseUrl
String	bodyType()
HTTP.Builder	bodyType(String bodyType)
HTTP	build()	构建 HTTP 实例
HTTP.Builder	callbackExecutor(Executor executor)	设置回调执行器，例如实现切换线程功能，只对异步请求有效
Charset	charset()
HTTP.Builder	charset(Charset charset)
HTTP.Builder	clearContentTypes()	清空 ContentType
HTTP.Builder	clearMsgConvertors()	清空消息转换器
HTTP.Builder	clearPreprocessors()	清空预处理器（包括串行预处理器）
TaskListener<HttpResult.State>	completeListener()
HTTP.Builder	completeListener(TaskListener<HttpResult.State> listener)	设置全局完成监听
HTTP.Builder	config(HTTP.OkConfig config)	自 v3.2.0 后可以多次调用 配置 OkHttpClient
String[]	contentTypes()
HTTP.Builder	contentTypes(String contentType)	配置支持的报文体类型
HTTP.Builder	contentTypes(List<String> contentTypes)	配置支持的报文体类型
DownloadHelper	downloadHelper()
HTTP.Builder	downloadHelper(DownloadHelper downloadHelper)
DownListener	downloadListener()
HTTP.Builder	downloadListener(DownListener listener)	设置下载监听器
TaskListener<IOException>	exceptionListener()
HTTP.Builder	exceptionListener(TaskListener<IOException> listener)	设置全局异常监听
Map<String,String>	getMediaTypes()
Executor	mainExecutor()
HTTP.Builder	mediaTypes(String key, String value)	配置媒体类型
HTTP.Builder	mediaTypes(Map<String,String> mediaTypes)	配置媒体类型
MsgConvertor[]	msgConvertors()
okhttp3.OkHttpClient	okClient()
Preprocessor[]	preprocessors()
int	preprocTimeoutTimes()
HTTP.Builder	preprocTimeoutTimes(int times)	最大预处理时间（倍数，相当普通请求的超时时间）
TaskListener<HttpResult>	responseListener()
HTTP.Builder	responseListener(TaskListener<HttpResult> listener)	设置全局响应监听
Scheduler	taskScheduler()
HTTP.Builder	taskScheduler(Scheduler scheduler)	配置 任务调度器，可用的调度由 WHttpTask.heatbeat(int, int) 指定的心跳任务 若不配置，则生成一个 线程容量为 1 的 ScheduledThreadPoolExecutor 调度器

从类继承的方法 java.lang.Object

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

构造器详细资料

OkHttpBuilderImpl

public OkHttpBuilderImpl()

OkHttpBuilderImpl

public OkHttpBuilderImpl(OkHttpClientWrapper hc)

方法详细资料

config

public HTTP.Builder config(HTTP.OkConfig config)

从接口复制的说明: HTTP.Builder

自 v3.2.0 后可以多次调用 配置 OkHttpClient

指定者:

config 在接口中 HTTP.Builder

参数:

config - 配置器

返回:

Builder

baseUrl

public HTTP.Builder baseUrl(String baseUrl)

从接口复制的说明: HTTP.Builder

设置 baseUrl

指定者:

baseUrl 在接口中 HTTP.Builder

参数:

baseUrl - 全局URL前缀

返回:

Builder

mediaTypes

public HTTP.Builder mediaTypes(Map<String,String> mediaTypes)

从接口复制的说明: HTTP.Builder

配置媒体类型

指定者:

mediaTypes 在接口中 HTTP.Builder

参数:

mediaTypes - 媒体类型

返回:

Builder

mediaTypes

public HTTP.Builder mediaTypes(String key,
 String value)

从接口复制的说明: HTTP.Builder

配置媒体类型

指定者:

mediaTypes 在接口中 HTTP.Builder

参数:

key - 媒体类型KEY

value - 媒体类型VALUE

返回:

Builder

clearContentTypes

public HTTP.Builder clearContentTypes()

从接口复制的说明: HTTP.Builder

清空 ContentType

指定者:

clearContentTypes 在接口中 HTTP.Builder

返回:

Builder

contentTypes

public HTTP.Builder contentTypes(List<String> contentTypes)

从接口复制的说明: HTTP.Builder

配置支持的报文体类型

指定者:

contentTypes 在接口中 HTTP.Builder

参数:

contentTypes - 报文体类型列表

返回:

Builder

contentTypes

public HTTP.Builder contentTypes(String contentType)

从接口复制的说明: HTTP.Builder

配置支持的报文体类型

指定者:

contentTypes 在接口中 HTTP.Builder

参数:

contentType - 报文体类型

返回:

Builder

callbackExecutor

public HTTP.Builder callbackExecutor(Executor executor)

从接口复制的说明: HTTP.Builder

设置回调执行器，例如实现切换线程功能，只对异步请求有效

指定者:

callbackExecutor 在接口中 HTTP.Builder

参数:

executor - 回调执行器

返回:

Builder

taskScheduler

public HTTP.Builder taskScheduler(Scheduler scheduler)

从接口复制的说明: HTTP.Builder

配置 任务调度器，可用的调度由 WHttpTask.heatbeat(int, int) 指定的心跳任务 若不配置，则生成一个 线程容量为 1 的 ScheduledThreadPoolExecutor 调度器

指定者:

taskScheduler 在接口中 HTTP.Builder

参数:

scheduler - 调度器

返回:

Builder

addPreprocessor

public HTTP.Builder addPreprocessor(Preprocessor preprocessor)

从接口复制的说明: HTTP.Builder

添加可并行处理请求任务的预处理器

指定者:

addPreprocessor 在接口中 HTTP.Builder

参数:

preprocessor - 预处理器

返回:

Builder

addSerialPreprocessor

public HTTP.Builder addSerialPreprocessor(Preprocessor preprocessor)

从接口复制的说明: HTTP.Builder

添加串行预处理器

指定者:

addSerialPreprocessor 在接口中 HTTP.Builder

参数:

preprocessor - 预处理器

返回:

Builder

clearPreprocessors

public HTTP.Builder clearPreprocessors()

从接口复制的说明: HTTP.Builder

清空预处理器（包括串行预处理器）

指定者:

clearPreprocessors 在接口中 HTTP.Builder

返回:

Builder

preprocTimeoutTimes

public HTTP.Builder preprocTimeoutTimes(int times)

从接口复制的说明: HTTP.Builder

最大预处理时间（倍数，相当普通请求的超时时间）

指定者:

preprocTimeoutTimes 在接口中 HTTP.Builder

参数:

times - 普通超时时间的倍数，默认为 10

返回:

Builder

responseListener

public HTTP.Builder responseListener(TaskListener<HttpResult> listener)

从接口复制的说明: HTTP.Builder

设置全局响应监听

指定者:

responseListener 在接口中 HTTP.Builder

参数:

listener - 监听器

返回:

Builder

exceptionListener

public HTTP.Builder exceptionListener(TaskListener<IOException> listener)

从接口复制的说明: HTTP.Builder

设置全局异常监听

指定者:

exceptionListener 在接口中 HTTP.Builder

参数:

listener - 监听器

返回:

Builder

completeListener

public HTTP.Builder completeListener(TaskListener<HttpResult.State> listener)

从接口复制的说明: HTTP.Builder

设置全局完成监听

指定者:

completeListener 在接口中 HTTP.Builder

参数:

listener - 监听器

返回:

Builder

downloadListener

public HTTP.Builder downloadListener(DownListener listener)

从接口复制的说明: HTTP.Builder

设置下载监听器

指定者:

downloadListener 在接口中 HTTP.Builder

参数:

listener - 监听器

返回:

Builder

addMsgConvertor

public HTTP.Builder addMsgConvertor(MsgConvertor msgConvertor)

指定者:

addMsgConvertor 在接口中 HTTP.Builder

参数:

msgConvertor - JSON 服务

返回:

Builder

clearMsgConvertors

public HTTP.Builder clearMsgConvertors()

从接口复制的说明: HTTP.Builder

清空消息转换器

指定者:

clearMsgConvertors 在接口中 HTTP.Builder

返回:

Builder

charset

public HTTP.Builder charset(Charset charset)

指定者:

charset 在接口中 HTTP.Builder

参数:

charset - 编码

返回:

Builder

bodyType

public HTTP.Builder bodyType(String bodyType)

指定者:

bodyType 在接口中 HTTP.Builder

参数:

bodyType - 请求体类型

返回:

Builder

build

public HTTP build()

从接口复制的说明: HTTP.Builder

构建 HTTP 实例

指定者:

build 在接口中 HTTP.Builder

返回:

HTTP

okClient

public okhttp3.OkHttpClient okClient()

baseUrl

public String baseUrl()

指定者:

baseUrl 在接口中 HTTP.Builder

getMediaTypes

public Map<String,String> getMediaTypes()

指定者:

getMediaTypes 在接口中 HTTP.Builder

mainExecutor

public Executor mainExecutor()

指定者:

mainExecutor 在接口中 HTTP.Builder

preprocessors

public Preprocessor[] preprocessors()

指定者:

preprocessors 在接口中 HTTP.Builder

downloadListener

public DownListener downloadListener()

指定者:

downloadListener 在接口中 HTTP.Builder

responseListener

public TaskListener<HttpResult> responseListener()

指定者:

responseListener 在接口中 HTTP.Builder

exceptionListener

public TaskListener<IOException> exceptionListener()

指定者:

exceptionListener 在接口中 HTTP.Builder

completeListener

public TaskListener<HttpResult.State> completeListener()

指定者:

completeListener 在接口中 HTTP.Builder

msgConvertors

public MsgConvertor[] msgConvertors()

指定者:

msgConvertors 在接口中 HTTP.Builder

taskScheduler

public Scheduler taskScheduler()

指定者:

taskScheduler 在接口中 HTTP.Builder

contentTypes

public String[] contentTypes()

指定者:

contentTypes 在接口中 HTTP.Builder

preprocTimeoutTimes

public int preprocTimeoutTimes()

指定者:

preprocTimeoutTimes 在接口中 HTTP.Builder

charset

public Charset charset()

指定者:

charset 在接口中 HTTP.Builder

bodyType

public String bodyType()

指定者:

bodyType 在接口中 HTTP.Builder

downloadHelper

public HTTP.Builder downloadHelper(DownloadHelper downloadHelper)

指定者:

downloadHelper 在接口中 HTTP.Builder

参数:

downloadHelper - 解析器

返回:

Builder

downloadHelper

public DownloadHelper downloadHelper()

指定者:

downloadHelper 在接口中 HTTP.Builder