cn.yerl.android.promise.http

类 PromiseRequest

java.lang.Object

cn.yerl.android.promise.http.PromiseRequest

所有已实现的接口:

java.io.Serializable

public class PromiseRequest
extends java.lang.Object
implements java.io.Serializable

封装请求参数类 Created by yan on 16/6/6.

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	PromiseRequest.Method HttpMethod
static interface	PromiseRequest.OnProgressChanged 请求进度监听接口

字段概要

字段

限定符和类型	字段和说明
protected java.io.File	binaryBody
protected java.util.Map<java.lang.String,java.lang.Object>	bodyParams
protected java.lang.String	rawBody

构造器概要

构造器

构造器和说明
PromiseRequest(java.lang.String url, PromiseRequest.Method method)

方法概要

限定符和类型	方法和说明
void	addDownloadProgressListener(PromiseRequest.OnProgressChanged progressListener) 下载进度反馈
void	cancel() 取消请求
PromiseRequest	clearBodeParams() 清除所有Body参数
PromiseRequest	clearHeaders() 移除所有Header
PromiseRequest	clearPathParams() 清除所有Path参数
PromiseRequest	clearQueryParams() 清除所有URL参数
static PromiseRequest	DELETE(java.lang.String url) 生成一个Http DELETE请求
static PromiseRequest	GET(java.lang.String url) 生成一个Http Get请求
java.io.File	getBinaryBody() 获取 Binary Body
java.util.Map<java.lang.String,java.lang.Object>	getBodyParams() 获取Body参数
java.util.Date	getCreateTime() 获取请求创建时间
java.lang.String	getEncoding() 获取请求编码
java.util.Map<java.lang.String,java.lang.String>	getHeaders() 获取Header
PromiseRequest.Method	getMethod() 获取Http Method
java.util.Map<java.lang.String,java.lang.Object>	getPathParams() 获取Path参数
java.util.Map<java.lang.String,java.lang.String>	getQueryParams() 获取URL参数
java.lang.String	getRawBody() 获取 Raw Body
protected HttpUriRequest	getRequest(PromiseHttp http, ResponseHandlerInterface handler)
java.lang.String	getUrlString() 获取请求地址
static PromiseRequest	HEAD(java.lang.String url) 生成一个Http HEAD请求
static PromiseRequest	POST(java.lang.String url) 生成一个Http POST请求
static PromiseRequest	PUT(java.lang.String url) 生成一个Http PUT请求
PromiseRequest	removeBinaryBody() 清除 Binary Body
PromiseRequest	removeBodyParam(java.lang.String... keys) 移除Body参数
PromiseRequest	removeHeader(java.lang.String... keys) 移除Header
PromiseRequest	removePathParam(java.lang.String... keys) 移除Path参数
PromiseRequest	removeQueryParam(java.lang.String... keys) 移除URL参数
PromiseRequest	removeRawBody() 清除 Raw Body
PromiseRequest	setEncoding(java.lang.String encoding) 设置请求、响应编码，默认UTF-8
PromiseRequest	withBinaryBody(java.io.File body) Binary Body
PromiseRequest	withBodyParam(java.lang.String key, java.lang.Object value) 添加一个Body参数
PromiseRequest	withBodyParams(java.util.Map<java.lang.String,java.lang.Object> bodyParams) 添加多个Body参数
PromiseRequest	withHeader(java.lang.String key, java.lang.String value) 添加一个Header
PromiseRequest	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) 添加多个Header
PromiseRequest	withPathParam(java.lang.String key, java.lang.Object value) 添加Path参数, 使用{}进行占位
PromiseRequest	withPathParams(java.util.Map<java.lang.String,java.lang.Object> pathParams) 添加多个Path参数, 使用{}进行占位
PromiseRequest	withQueryParam(java.lang.String key, java.lang.String value) 添加一个URL参数
PromiseRequest	withQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams) 添加多个URL参数
PromiseRequest	withRawBody(java.lang.String body) Raw Body

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

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

字段详细资料

rawBody

protected java.lang.String rawBody

binaryBody

protected java.io.File binaryBody

bodyParams

protected java.util.Map<java.lang.String,java.lang.Object> bodyParams

构造器详细资料

PromiseRequest

public PromiseRequest(java.lang.String url,
                      PromiseRequest.Method method)

方法详细资料

GET

public static PromiseRequest GET(java.lang.String url)

生成一个Http Get请求

参数:

url - 服务器地址

返回:

PromiseRequest

POST

public static PromiseRequest POST(java.lang.String url)

生成一个Http POST请求

参数:

url - 服务器地址

返回:

PromiseRequest

PUT

public static PromiseRequest PUT(java.lang.String url)

生成一个Http PUT请求

参数:

url - 服务器地址

返回:

PromiseRequest

DELETE

public static PromiseRequest DELETE(java.lang.String url)

生成一个Http DELETE请求

参数:

url - 服务器地址

返回:

PromiseRequest

HEAD

public static PromiseRequest HEAD(java.lang.String url)

生成一个Http HEAD请求

参数:

url - 服务器地址

返回:

PromiseRequest

withQueryParam

public PromiseRequest withQueryParam(java.lang.String key,
                                     java.lang.String value)

添加一个URL参数

参数:

key - 参数名

value - 参数值

返回:

PromiseRequest

withQueryParams

public PromiseRequest withQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams)

添加多个URL参数

参数:

queryParams - 参数键值对

返回:

PromiseRequest

removeQueryParam

public PromiseRequest removeQueryParam(java.lang.String... keys)

移除URL参数

参数:

keys - 参数key

返回:

PromiseRequest

clearQueryParams

public PromiseRequest clearQueryParams()

清除所有URL参数

返回:

PromiseRequest

withPathParam

public PromiseRequest withPathParam(java.lang.String key,
                                    java.lang.Object value)

添加Path参数, 使用{}进行占位

参数:

key - 参数名

value - 参数值

返回:

PromiseRequest

withPathParams

public PromiseRequest withPathParams(java.util.Map<java.lang.String,java.lang.Object> pathParams)

添加多个Path参数, 使用{}进行占位

参数:

pathParams - 参数键值对

返回:

PromiseRequest

removePathParam

public PromiseRequest removePathParam(java.lang.String... keys)

移除Path参数

参数:

keys - 参数key

返回:

PromiseRequest

clearPathParams

public PromiseRequest clearPathParams()

清除所有Path参数

返回:

PromiseRequest

withBodyParam

public PromiseRequest withBodyParam(java.lang.String key,
                                    java.lang.Object value)

添加一个Body参数

参数:

key - 参数名

value - 参数值

返回:

PromiseRequest

withBodyParams

public PromiseRequest withBodyParams(java.util.Map<java.lang.String,java.lang.Object> bodyParams)

添加多个Body参数

参数:

bodyParams - 参数键值对

返回:

PromiseRequest

removeBodyParam

public PromiseRequest removeBodyParam(java.lang.String... keys)

移除Body参数

参数:

keys - 参数key

返回:

PromiseRequest

clearBodeParams

public PromiseRequest clearBodeParams()

清除所有Body参数

返回:

PromiseRequest

withRawBody

public PromiseRequest withRawBody(java.lang.String body)

Raw Body

参数:

body - raw

返回:

PromiseRequest

getRawBody

public java.lang.String getRawBody()

获取 Raw Body

返回:

Raw Body

removeRawBody

public PromiseRequest removeRawBody()

清除 Raw Body

返回:

PromiseRequest

withBinaryBody

public PromiseRequest withBinaryBody(java.io.File body)

Binary Body

返回:

PromiseRequest

getBinaryBody

public java.io.File getBinaryBody()

获取 Binary Body

返回:

Binary Body

removeBinaryBody

public PromiseRequest removeBinaryBody()

清除 Binary Body

返回:

PromiseRequest

withHeader

public PromiseRequest withHeader(java.lang.String key,
                                 java.lang.String value)

添加一个Header

参数:

key - Header名

value - Header值

返回:

PromiseRequest

withHeaders

public PromiseRequest withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

添加多个Header

参数:

headers - Header键值对

返回:

PromiseRequest

removeHeader

public PromiseRequest removeHeader(java.lang.String... keys)

移除Header

参数:

keys - 参数key

返回:

PromiseRequest

clearHeaders

public PromiseRequest clearHeaders()

移除所有Header

返回:

PromiseRequest

addDownloadProgressListener

public void addDownloadProgressListener(PromiseRequest.OnProgressChanged progressListener)

下载进度反馈

参数:

progressListener - 下载进度监听器

cancel

public void cancel()

取消请求

getMethod

public PromiseRequest.Method getMethod()

获取Http Method

返回:

Method

getUrlString

public java.lang.String getUrlString()

获取请求地址

返回:

UrlString

getEncoding

public java.lang.String getEncoding()

获取请求编码

返回:

String

setEncoding

public PromiseRequest setEncoding(java.lang.String encoding)

设置请求、响应编码，默认UTF-8

参数:

encoding - 编码

返回:

PromiseRequest

getCreateTime

public java.util.Date getCreateTime()

获取请求创建时间

返回:

Date

getQueryParams

public java.util.Map<java.lang.String,java.lang.String> getQueryParams()

获取URL参数

返回:

Map

getBodyParams

public java.util.Map<java.lang.String,java.lang.Object> getBodyParams()

获取Body参数

返回:

Map

getPathParams

public java.util.Map<java.lang.String,java.lang.Object> getPathParams()

获取Path参数

返回:

Map

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

获取Header

返回:

Map

getRequest

protected HttpUriRequest getRequest(PromiseHttp http,
                                    ResponseHandlerInterface handler)