net.dongliu.requests

类 RawResponse

java.lang.Object

net.dongliu.requests.RawResponse

所有已实现的接口:

AutoCloseable

public class RawResponse
extends Object
implements AutoCloseable

Raw http response. It you do not consume http response body, with readToText, readToBytes, writeToFile, toTextResponse, toJsonResponse, etc.., you need to close this raw response manually

作者:

Liu Dong

方法概要

限定符和类型	方法和说明
RawResponse	charset(Charset charset) Set response read charset.
void	close()
void	discardBody() Consume and discard this response body
Collection<Cookie>	getCookies() Get all cookies
Cookie	getFirstCookie(String name) Get first cookie match the name, return null if not exists
String	getFirstHeader(String name) Get header value with name.
List<Parameter<String>>	getHeaders() Return immutable response header list
List<String>	getHeaders(String name) Get all headers values with name.
InputStream	getInput() The response body input stream
int	getStatusCode() The response status code
String	getStatusLine() Get the status line
byte[]	readToBytes() Read response body to byte array. return empty byte array if response has no body
<T> T	readToJson(Class<T> cls) Deserialize response content as json
<T> T	readToJson(Type type) Deserialize response content as json
<T> T	readToJson(TypeInfer<T> typeInfer) Deserialize response content as json
String	readToText() Read response body to string. return empty string if response has no body
Response<byte[]>	toBytesResponse() Convert to response, with body as byte array
Response<File>	toFileResponse(Path path) Write response body to file, and return response contains the file.
<T> Response<T>	toJsonResponse(Class<T> cls) Convert http response body to json result
<T> Response<T>	toJsonResponse(TypeInfer<T> typeInfer) Convert http response body to json result
Response<String>	toTextResponse() Convert to response, with body as text.
RawResponse	withCharset(Charset charset) 已过时。 use {charset(Charset)} instead
void	writeTo(OutputStream out) Write response body to OutputStream.
void	writeTo(Writer writer) Write response body to Writer, charset can be set using charset(Charset), or will use charset detected from response header if not set.
void	writeToFile(File file) Write response body to file
void	writeToFile(Path path) Write response body to file
void	writeToFile(String path) Write response body to file

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

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

方法详细资料

close

public void close()

指定者:

close 在接口中 AutoCloseable

withCharset

@Deprecated
public RawResponse withCharset(Charset charset)

已过时。 use {charset(Charset)} instead

Set response read charset. If not set, will get charset from response headers.

charset

public RawResponse charset(Charset charset)

Set response read charset. If not set, will get charset from response headers.

readToText

public String readToText()

Read response body to string. return empty string if response has no body

toTextResponse

public Response<String> toTextResponse()

Convert to response, with body as text. The origin raw response will be closed

readToBytes

public byte[] readToBytes()

Read response body to byte array. return empty byte array if response has no body

toBytesResponse

public Response<byte[]> toBytesResponse()

Convert to response, with body as byte array

readToJson

public <T> T readToJson(Type type)

Deserialize response content as json

返回:

null if json value is null or empty

readToJson

public <T> T readToJson(TypeInfer<T> typeInfer)

Deserialize response content as json

返回:

null if json value is null or empty

readToJson

public <T> T readToJson(Class<T> cls)

Deserialize response content as json

返回:

null if json value is null or empty

toJsonResponse

public <T> Response<T> toJsonResponse(TypeInfer<T> typeInfer)

Convert http response body to json result

toJsonResponse

public <T> Response<T> toJsonResponse(Class<T> cls)

Convert http response body to json result

writeToFile

public void writeToFile(File file)

Write response body to file

writeToFile

public void writeToFile(Path path)

Write response body to file

writeToFile

public void writeToFile(String path)

Write response body to file

toFileResponse

public Response<File> toFileResponse(Path path)

Write response body to file, and return response contains the file.

writeTo

public void writeTo(OutputStream out)

Write response body to OutputStream. OutputStream will not be closed.

writeTo

public void writeTo(Writer writer)

Write response body to Writer, charset can be set using charset(Charset), or will use charset detected from response header if not set. Writer will not be closed.

discardBody

public void discardBody()

Consume and discard this response body

getStatusCode

public int getStatusCode()

The response status code

getStatusLine

public String getStatusLine()

Get the status line

getInput

public InputStream getInput()

The response body input stream

getFirstHeader

@Nullable
public String getFirstHeader(String name)

Get header value with name. If not exists, return null

getHeaders

@Nonnull
public List<Parameter<String>> getHeaders()

Return immutable response header list

getHeaders

@Nonnull
public List<String> getHeaders(String name)

Get all headers values with name. If not exists, return empty list

getCookies

public Collection<Cookie> getCookies()

Get all cookies

getFirstCookie

@Nullable
public Cookie getFirstCookie(String name)

Get first cookie match the name, return null if not exists