ResponseBuilder<T,E> 接口

  • 参考
包:
com.microsoft.bot.restclient.protocol
Maven 项目:
com.microsoft.bot:bot-connector:4.14.3

类型参数

T

如果状态代码被视为成功，则正文类型

E

如果状态代码被视为失败，则为异常类型

public interface ResponseBuilder<T,E>

定义一个接口，该接口可以根据注册的状态代码将一个改造 2 响应处理成反序列化的正文或异常。

方法摘要

修饰符和类型 方法和描述
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

生成服务响应使用 REST 调用响应中的标头实例、JSON 格式的标头以及可能的错误（没有响应正文）。
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

生成服务响应使用 REST 调用响应标头实例、JSON 格式的标头和可能的错误。
abstract ServiceResponse<T> build(Response<ResponseBody> response)

从 REST 调用响应和可能的错误生成服务响应实例。
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

从 REST 调用响应生成服务响应实例，并生成可能的错误，该错误没有响应正文。
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

注册从响应状态代码到响应目标类型的映射。
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

为模型的错误注册目标类型。

方法详细信息

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

从 REST 调用响应、JSON 格式的标头和可能的错误（没有响应正文）生成 ServiceResponseWithHeaders 实例。

如果注册响应中的状态代码，则响应将被视为有效。 如果未注册状态代码，则响应将被视为无效。 还会引发 AutoRestException。

参数:

response - REST 调用中的 Response 实例
headerType - 标头的类型

返回:

泛型类型的 ServiceResponseWithHeaders 实例 T

引发:

java.io.IOException - REST 调用中的异常

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

从 REST 调用响应、JSON 格式的标头和可能的错误生成 ServiceResponseWithHeaders 实例。

如果注册响应中的状态代码，则响应将被视为有效，并反序列化为指定的目标类型。 如果未注册状态代码，则响应将被视为无效，并反序列化为指定的错误类型（如果有）。 还会引发 AutoRestException。

参数:

response - REST 调用中的 Response 实例
headerType - 标头的类型

返回:

泛型类型的 ServiceResponseWithHeaders 实例 T

引发:

java.io.IOException - REST 调用中的异常

build

public abstract ServiceResponse build(Response response)

从 REST 调用响应和可能的错误生成 ServiceResponse 实例。

如果注册响应中的状态代码，则响应将被视为有效，并反序列化为指定的目标类型。 如果未注册状态代码，则响应将被视为无效，并反序列化为指定的错误类型（如果有）。 还会引发 AutoRestException。

参数:

response - REST 调用中的 Response 实例

返回:

泛型类型的 ServiceResponse 实例 T

引发:

java.io.IOException - REST 调用中的异常

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

从 REST 调用响应生成 ServiceResponse 实例，并生成可能的错误，该错误没有响应正文。

如果注册响应中的状态代码，则响应将被视为有效。 如果未注册状态代码，则响应将被视为无效。 还会引发 AutoRestException。

参数:

response - REST 调用中的 Response 实例

返回:

泛型类型的 ServiceResponse 实例 T

引发:

java.io.IOException - REST 调用中的异常

register

public abstract ResponseBuilder register(int statusCode, Type type)

注册从响应状态代码到响应目标类型的映射。

参数:

statusCode - 状态代码。
type - 要反序列化的类型。

返回:

同一个生成器实例。

registerError

public abstract ResponseBuilder registerError(Class type)

为模型的错误注册目标类型。

参数:

type - 要反序列化的类型。

返回:

同一个生成器实例。

适用于