Module bus.http

Package org.miaixz.bus.http.plugin.httpv

Class ResultBody

java.lang.Object

org.miaixz.bus.http.plugin.httpv.ResultBody

All Implemented Interfaces:

CoverResult.Body

public class ResultBody
extends Object
implements CoverResult.Body

Since:

Java 17+

Author:

Kimi Liu

Field Summary

Fields

Modifier and Type	Field	Description
protected Charset	charset
protected CoverTasks.Executor	executor

Constructor Summary

Constructors

Constructor	Description
ResultBody(CoverHttp<?> coverHttp, Response response, CoverTasks.Executor executor)

Method Summary

Modifier and Type	Method	Description
CoverResult.Body	cache()	缓存自己，缓存后可 重复使用 toXXX 类方法
CoverResult.Body	close()	关闭报文体 未对报文体做任何消费时使用，比如只读取长度
long	getLength()
org.miaixz.bus.core.lang.MediaType	getType()
CoverResult.Body	nextOnIO()	在IO线程执行
CoverResult.Body	setOnProcess(Callback<Progress> onProcess)	设置报文体接收进度回调
CoverResult.Body	setRangeIgnored()	设置进度回调忽略响应的Range头信息，即进度回调会从0开始
CoverResult.Body	stepBytes(long stepBytes)	设置进度回调的步进字节，默认 8K（8192） 表示每接收 stepBytes 个字节，执行一次进度回调
CoverResult.Body	stepRate(double stepRate)	设置进度回调的步进比例 表示每接收 stepRate 比例，执行一次进度回调
CoverArray	toArray()
<T> T	toBean(Class<T> type)
byte[]	toBytes()
InputStream	toByteStream()
org.miaixz.bus.core.io.ByteString	toByteString()
Reader	toCharStream()
Downloads	toFile(File file)	下载到指定文件 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
Downloads	toFile(String filePath)	下载到指定路径 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
Downloads	toFolder(File dir)	下载到指定文件夹 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
Downloads	toFolder(String dirPath)	下载到指定文件夹 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
<T> List<T>	toList(Class<T> type)
String	toString()
CoverWapper	toWapper()

Methods inherited from class java.lang.Object

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

Field Details

executor

protected CoverTasks.Executor executor

charset

protected Charset charset

Constructor Details

ResultBody

public ResultBody(CoverHttp<?> coverHttp,
 Response response,
 CoverTasks.Executor executor)

Method Details

toWapper

public CoverWapper toWapper()

Specified by:

toWapper in interface CoverResult.Body

Returns:

消息体转 Mapper 对象（不想定义 Java Bean 时使用）

toArray

public CoverArray toArray()

Specified by:

toArray in interface CoverResult.Body

Returns:

消息体转 Array 数组（不想定义 Java Bean 时使用）

toBean

public <T> T toBean(Class<T> type)

Specified by:

toBean in interface CoverResult.Body

Type Parameters:

T - 目标泛型

Parameters:

type - 目标类型

Returns:

报文体Json文本转JavaBean

toList

public <T> List<T> toList(Class<T> type)

Specified by:

toList in interface CoverResult.Body

Type Parameters:

T - 目标泛型

Parameters:

type - 目标类型

Returns:

报文体Json文本转JavaBean列表

getType

public org.miaixz.bus.core.lang.MediaType getType()

Specified by:

getType in interface CoverResult.Body

Returns:

媒体类型

getLength

public long getLength()

Specified by:

getLength in interface CoverResult.Body

Returns:

报文体字节长度

nextOnIO

public CoverResult.Body nextOnIO()

Description copied from interface: CoverResult.Body

在IO线程执行

Specified by:

nextOnIO in interface CoverResult.Body

Returns:

Body

setOnProcess

public CoverResult.Body setOnProcess(Callback<Progress> onProcess)

Description copied from interface: CoverResult.Body

设置报文体接收进度回调

Specified by:

setOnProcess in interface CoverResult.Body

Parameters:

onProcess - 进度回调函数

Returns:

Body

stepBytes

public CoverResult.Body stepBytes(long stepBytes)

Description copied from interface: CoverResult.Body

设置进度回调的步进字节，默认 8K（8192） 表示每接收 stepBytes 个字节，执行一次进度回调

Specified by:

stepBytes in interface CoverResult.Body

Parameters:

stepBytes - 步进字节

Returns:

Body

stepRate

public CoverResult.Body stepRate(double stepRate)

Description copied from interface: CoverResult.Body

设置进度回调的步进比例 表示每接收 stepRate 比例，执行一次进度回调

Specified by:

stepRate in interface CoverResult.Body

Parameters:

stepRate - 步进比例

Returns:

Body

setRangeIgnored

public CoverResult.Body setRangeIgnored()

Description copied from interface: CoverResult.Body

设置进度回调忽略响应的Range头信息，即进度回调会从0开始

Specified by:

setRangeIgnored in interface CoverResult.Body

Returns:

Body

toByteStream

public InputStream toByteStream()

Specified by:

toByteStream in interface CoverResult.Body

Returns:

消息体转字节流

toBytes

public byte[] toBytes()

Specified by:

toBytes in interface CoverResult.Body

Returns:

消息体转字节数组

toCharStream

public Reader toCharStream()

Specified by:

toCharStream in interface CoverResult.Body

Returns:

消息体转字符流

toString

public String toString()

Specified by:

toString in interface CoverResult.Body

Overrides:

toString in class Object

Returns:

消息体转字符串

toByteString

public org.miaixz.bus.core.io.ByteString toByteString()

Specified by:

toByteString in interface CoverResult.Body

Returns:

ByteString

toFile

public Downloads toFile(String filePath)

Description copied from interface: CoverResult.Body

下载到指定路径 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次

Specified by:

toFile in interface CoverResult.Body

Parameters:

filePath - 目标路径

Returns:

下载过程 #Download

toFile

public Downloads toFile(File file)

Description copied from interface: CoverResult.Body

下载到指定文件 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次

Specified by:

toFile in interface CoverResult.Body

Parameters:

file - 目标文件

Returns:

下载过程 #Download

toFolder

public Downloads toFolder(String dirPath)

Description copied from interface: CoverResult.Body

下载到指定文件夹 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次

Specified by:

toFolder in interface CoverResult.Body

Parameters:

dirPath - 目标目录

Returns:

下载过程 #Download

toFolder

public Downloads toFolder(File dir)

Description copied from interface: CoverResult.Body

下载到指定文件夹 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次

Specified by:

toFolder in interface CoverResult.Body

Parameters:

dir - 目标目录

Returns:

下载过程 #Download

cache

public CoverResult.Body cache()

Description copied from interface: CoverResult.Body

缓存自己，缓存后可 重复使用 toXXX 类方法

Specified by:

cache in interface CoverResult.Body

Returns:

Body

close

public CoverResult.Body close()

Description copied from interface: CoverResult.Body

关闭报文体 未对报文体做任何消费时使用，比如只读取长度

Specified by:

close in interface CoverResult.Body

Returns:

Body