ServiceResponseBuilder<T,E> 类

  • 参考
包:
com.microsoft.bot.restclient
Maven 项目:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

类型参数

T

调用方期望的返回类型来自 REST 响应。

E

发生错误时引发的异常。

实现

ResponseBuilder<T，E>

public final class ServiceResponseBuilder<T,E>
implements ResponseBuilder<T,E>

用于生成 ServiceResponse<T>的生成器。

方法摘要

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

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

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

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

从 REST 调用响应生成服务响应实例，并生成可能的错误，该错误没有响应正文。
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

检查返回的状态代码是否被视为此生成器的成功。
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

注册从响应状态代码到响应目标类型的映射。
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

注册从响应状态代码到存储在 Map中的响应目标类型的所有映射。
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

为模型的错误注册目标类型。
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

指定是否从 GET 调用引发 404 响应。

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

方法详细信息

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

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

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

参数:

response
headerType

引发:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

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

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

参数:

response
headerType

引发:

java.io.IOException

build

public ServiceResponse build(Response response)

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

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

参数:

response

引发:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

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

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

参数:

response

引发:

java.io.IOException

exceptionType

public Class exceptionType()

返回:

发生错误时引发的异常类型。

isSuccessful

public boolean isSuccessful(int statusCode)

检查返回的状态代码是否被视为此生成器的成功。

参数:

statusCode - 要检查的状态代码

返回:

如果成功，则为 true;否则为 false。

register

public ServiceResponseBuilder register(int statusCode, Type type)

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

参数:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

注册从响应状态代码到存储在 Map中的响应目标类型的所有映射。

参数:

responseTypes - 从响应状态代码到响应类型的映射。

返回:

同一个生成器实例。

registerError

public ServiceResponseBuilder registerError(Class type)

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

参数:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

指定是否从 GET 调用引发 404 响应。

参数:

throwOnGet404 - 如果引发，则为 true;如果为 false，则只需返回 null。 默认值为 false。

返回:

响应生成器本身

适用于