ForestResponse (forest-码云(gitee.com))

java.lang.Object
- com.dtflys.forest.http.ForestResponse<T>

Direct Known Subclasses:

HttpclientForestResponse, OkHttp3ForestResponse
```
public abstract class ForestResponse<T>
extends Object
```
Forest请求响应类

Since:

1.1.0

Author:

gongjun[dt_flys@hotmail.com]

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`content` 响应内容文本（不包括二进制数据内容的文本）
`protected String`	`contentEncoding` 响应内容的数据编码
`protected long`	`contentLength` 请求响应内容的数据长度
`protected ContentType`	`contentType` 响应内容的数据类型
`protected Throwable`	`exception` 请求发送过程中可能产生的异常
`protected String`	`filename` 文件名
`protected ForestHeaderMap`	`headers` 请求响应头集合
`protected ForestRequest`	`request` 请求对象
`protected T`	`result` 响应内容反序列化成对象后的结果
`protected Integer`	`statusCode` 网络状态码

Constructor Summary

Constructors
Constructor and Description

ForestResponse(ForestRequest request)

Constructors
Constructor and Description
`ForestResponse(ForestRequest request)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`byteToString(byte[] bytes)` 把字节数组转换成字符串（自动根据字符串编码转换）
`abstract byte[]`	`getByteArray()` 以字节数组的形式获取请求响应内容
`String`	`getContent()` 获取请求响应内容文本和`readAsString()`不同的地方在于， `getContent()`不会读取二进制形式数据内容，而`readAsString()`会将二进制数据转换成字符串读取
`String`	`getContentEncoding()` 获取请求响应内容的数据编码
`long`	`getContentLength()` 获取请求响应内容的数据长度
`ContentType`	`getContentType()` 获取请求响应内容的数据类型
`Throwable`	`getException()` 获取请求发送过程中的异常
`ForestHeader`	`getHeader(String name)` 根据响应头名称获取单个请求响应头
`ForestHeaderMap`	`getHeaders()` 获取请求响应的所有响应头
`List<ForestHeader>`	`getHeaders(String name)` 根据响应头名称获取请求响应头列表
`String`	`getHeaderValue(String name)` 根据响应头名称获取请求响应头值
`List<String>`	`getHeaderValues(String name)` 根据响应头名称获取请求响应头值列表
`InputStream`	`getInputStream()` 以输入流的形式获取请求响应内容
`ForestRequest`	`getRequest()` 获取该响应对象对应的请求对象
`T`	`getResult()` 获取反序列化成对象类型的请求响应内容
`int`	`getStatusCode()` 获取请求响应的状态码
`boolean`	`isError()` 网络请求是否失败
`abstract boolean`	`isReceivedResponseData()` 是否已接受到响应数据
`boolean`	`isSuccess()` 网络请求是否成功
`String`	`readAsString()` 以字符串方式读取请求响应内容
`void`	`setContent(String content)`
`void`	`setContentType(ContentType contentType)` 设置请求响应内容的数据类型
`void`	`setException(Throwable exception)` 设置请求发送过程中的异常
`void`	`setResult(T result)` 设置反序列化成对象类型的请求响应内容
`void`	`setStatusCode(Integer statusCode)` 设置请求响应的状态码

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - request
```
protected ForestRequest request
```
    请求对象
  - statusCode
```
protected volatile Integer statusCode
```
    网络状态码
  - content
```
protected volatile String content
```
    响应内容文本（不包括二进制数据内容的文本）
  - filename
```
protected volatile String filename
```
    文件名
  - contentType
```
protected volatile ContentType contentType
```
    响应内容的数据类型
  - contentEncoding
```
protected volatile String contentEncoding
```
    响应内容的数据编码
  - contentLength
```
protected volatile long contentLength
```
    请求响应内容的数据长度
  - headers
```
protected volatile ForestHeaderMap headers
```
    请求响应头集合
  - exception
```
protected volatile Throwable exception
```
    请求发送过程中可能产生的异常
  - result
```
protected volatile T result
```
    响应内容反序列化成对象后的结果
- Constructor Detail
  - ForestResponse
```
public ForestResponse(ForestRequest request)
```
- Method Detail
  - getRequest
```
public ForestRequest getRequest()
```
    获取该响应对象对应的请求对象
    
    Returns:
    
    请求对象, ForestRequest类实例
  - getContent
```
public String getContent()
```
    获取请求响应内容文本和readAsString()不同的地方在于， getContent()不会读取二进制形式数据内容，而readAsString()会将二进制数据转换成字符串读取
    
    Returns:
    
    响应内容文本字符串
  - readAsString
```
public String readAsString()
```
    以字符串方式读取请求响应内容
    
    Returns:
    
    请求响应内容字符串
  - setContent
```
public void setContent(String content)
```
  - getResult
```
public T getResult()
```
    获取反序列化成对象类型的请求响应内容
    
    Returns:
    
    反序列化成对象类型的请求响应内容
  - setResult
```
public void setResult(T result)
```
    设置反序列化成对象类型的请求响应内容
    
    Parameters:
    
    result - 反序列化成对象类型的请求响应内容
  - getException
```
public Throwable getException()
```
    获取请求发送过程中的异常
    
    Returns:
    
    异常对象, Throwable类及其子类实例
  - setException
```
public void setException(Throwable exception)
```
    设置请求发送过程中的异常
    
    Parameters:
    
    exception - 异常对象, Throwable类及其子类实例
  - getStatusCode
```
public int getStatusCode()
```
    获取请求响应的状态码
    
    Returns:
    
    请求响应的状态码
  - setStatusCode
```
public void setStatusCode(Integer statusCode)
```
    设置请求响应的状态码
    
    Parameters:
    
    statusCode - 请求响应的状态码
  - getContentType
```
public ContentType getContentType()
```
    获取请求响应内容的数据类型
    
    Returns:
    
    请求响应内容的数据类型, ContentType类实例
  - setContentType
```
public void setContentType(ContentType contentType)
```
    设置请求响应内容的数据类型
    
    Parameters:
    
    contentType - 请求响应内容的数据类型, ContentType类实例
  - getContentEncoding
```
public String getContentEncoding()
```
    获取请求响应内容的数据编码
    
    Returns:
    
    请求响应内容的数据编码名称
  - getContentLength
```
public long getContentLength()
```
    获取请求响应内容的数据长度
    
    Returns:
    
    请求响应内容的数据长度
  - isSuccess
```
public boolean isSuccess()
```
    网络请求是否成功
    
    Returns:
    
    true: 成功， false: 失败
  - isError
```
public boolean isError()
```
    网络请求是否失败
    
    Returns:
    
    true: 失败
  - isReceivedResponseData
```
public abstract boolean isReceivedResponseData()
```
    是否已接受到响应数据
    
    Returns:
    
    true: 已接收到， false: 未接收到
  - getByteArray
```
public abstract byte[] getByteArray()
                             throws Exception
```
    以字节数组的形式获取请求响应内容
    
    Returns:
    
    字节数组形式的响应内容
    
    Throws:
    
    Exception - 读取字节数组过程中可能的异常
  - getInputStream
```
public InputStream getInputStream()
                           throws Exception
```
    以输入流的形式获取请求响应内容
    
    Returns:
    
    输入流形式的响应内容, InputStream实例
    
    Throws:
    
    Exception
  - getHeader
```
public ForestHeader getHeader(String name)
```
    根据响应头名称获取单个请求响应头
    
    Parameters:
    
    name - 响应头名称
    
    Returns:
    
    请求响应头, ForestHeader类实例
  - getHeaders
```
public List<ForestHeader> getHeaders(String name)
```
    根据响应头名称获取请求响应头列表
    
    Parameters:
    
    name - 响应头名称
    
    Returns:
    
    请求响应头列表
    
    See Also:
    
    ForestHeader
  - getHeaderValue
```
public String getHeaderValue(String name)
```
    根据响应头名称获取请求响应头值
    
    Parameters:
    
    name - 响应头名称
    
    Returns:
    
    请求响应头值
  - getHeaderValues
```
public List<String> getHeaderValues(String name)
```
    根据响应头名称获取请求响应头值列表
    
    Parameters:
    
    name - 响应头名称
    
    Returns:
    
    请求响应头值列表
  - getHeaders
```
public ForestHeaderMap getHeaders()
```
    获取请求响应的所有响应头
    
    Returns:
    
    请求响应头表, ForestHeaderMap类实例
  - byteToString
```
protected String byteToString(byte[] bytes)
                       throws IOException
```
    把字节数组转换成字符串（自动根据字符串编码转换）
    
    Parameters:
    
    bytes - 字节数组
    
    Returns:
    
    字符串
    
    Throws:
    
    IOException - 字符串处理异常

Class ForestResponse<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

request

statusCode

content

filename

contentType

contentEncoding

contentLength

headers

exception

result

Constructor Detail

ForestResponse

Method Detail

getRequest

getContent

readAsString

setContent

getResult

setResult

getException

setException

getStatusCode

setStatusCode

getContentType

setContentType

getContentEncoding

getContentLength

isSuccess

isError

isReceivedResponseData

getByteArray

getInputStream

getHeader

getHeaders

getHeaderValue

getHeaderValues

getHeaders

byteToString