程序包 cn.warpin.core.result

类 Result

java.lang.Object

cn.warpin.core.result.Result

public class Result
extends Object

封装接口统一返回结果。

字段概要

字段

修饰符和类型	字段	说明
private Integer	code	返回的状态码
private long	count	返回的数据总数
private String	msg	返回的消息
private List<Integer>	primaries	返回的主键列表
private Object	root	返回的数据
private int	totalPage	返回的总页数

构造器概要

构造器

构造器	说明
Result(ResCode rc)	构造函数，根据给定的结果码创建一个成功的返回结果。
Result(ResCode rc, String msg)	构造函数，根据给定的结果码和消息创建一个返回结果。
Result(Integer resCode, String msg)	创建一个自定义状态码和消息的返回结果。
Result(Object root, ResCode rc)	构造函数，根据给定的结果码和数据创建一个返回结果。
Result(Object root, ResCode rc, Long totalCount)	构造函数，根据给定的结果码、数据和总数创建一个返回结果。
Result(Object root, ResCode rc, String msg)	构造函数，根据给定的结果码、数据和消息创建一个返回结果。

方法概要

修饰符和类型	方法	说明
static Result	exception(Exception e)	创建一个异常返回结果。
static Result	fail()	创建一个失败的返回结果，不包含消息。
static Result	fail(ResCode rc)	创建一个失败的返回结果，包含指定的状态码。
static Result	fail(ResCode rc, String msg)	创建一个失败的返回结果，包含指定的状态码和消息。
static Result	fail(Integer resCode, String msg)	创建一个失败的返回结果，包含指定的状态码和消息。
static Result	fail(Object root, ResCode rc)	创建一个失败的返回结果，包含指定的数据和状态码。
static Result	fail(Object root, ResCode rc, String msg)	创建一个失败的返回结果，包含指定的数据、状态码和消息。
static Result	querySuccess(Object root)	构造函数，根据给定的结果码创建一个成功的返回结果。
static Result	querySuccess(Object root, long totalCount, int totalPage)	请求成功
static Result	querySuccess(Object root, long totalCount, int totalPage, List<Integer> primaries)	创建一个成功的返回结果，包含指定的数据、总数和总页数，以及主键列表。
static Result	querySuccess(Object root, List<Integer> primaries)	创建一个成功的返回结果，包含指定的数据和主键列表。
static Result	success()	创建一个成功的返回结果，不包含数据。
static Result	success(ResCode rc, String msg)	创建一个成功的返回结果，包含指定的状态码和消息。
static Result	success(Object root)	创建一个成功的返回结果，包含指定的数据。
static Result	success(Object root, ResCode rc)	创建一个成功的返回结果，包含指定的数据和状态码。
static Result	success(Object root, ResCode rc, String msg)	创建一个成功的返回结果，包含指定的数据、状态码和消息。
static Result	success(Object root, Long totalCount)	创建一个成功的返回结果，包含指定的数据和总数。
static Result	success(org.springframework.data.domain.Page<?> page)	创建一个成功的返回结果，包含指定的分页数据。

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

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

字段详细资料

root

private Object root

返回的数据

msg

private String msg

返回的消息

code

private Integer code

返回的状态码

count

private long count

返回的数据总数

totalPage

private int totalPage

返回的总页数

primaries

private List<Integer> primaries

返回的主键列表

构造器详细资料

Result

public Result(ResCode rc)

构造函数，根据给定的结果码创建一个成功的返回结果。

参数:

rc - 结果码

Result

public Result(ResCode rc,
 String msg)

构造函数，根据给定的结果码和消息创建一个返回结果。

参数:

rc - 结果码

msg - 消息

Result

public Result(Integer resCode,
 String msg)

创建一个自定义状态码和消息的返回结果。

参数:

resCode - 自定义状态码

msg - 自定义消息

Result

public Result(Object root,
 ResCode rc)

构造函数，根据给定的结果码和数据创建一个返回结果。

参数:

root - 返回的数据

rc - 结果码

Result

public Result(Object root,
 ResCode rc,
 String msg)

构造函数，根据给定的结果码、数据和消息创建一个返回结果。

参数:

root - 返回的数据

rc - 结果码

msg - 消息

Result

public Result(Object root,
 ResCode rc,
 Long totalCount)

构造函数，根据给定的结果码、数据和总数创建一个返回结果。

参数:

root - 返回的数据

rc - 结果码

totalCount - 总数

方法详细资料

querySuccess

public static Result querySuccess(Object root)

构造函数，根据给定的结果码创建一个成功的返回结果。

参数:

root - 结果集

querySuccess

public static Result querySuccess(Object root,
 long totalCount,
 int totalPage)

请求成功

参数:

root -

totalCount -

totalPage -

返回:

querySuccess

public static Result querySuccess(Object root,
 List<Integer> primaries)

创建一个成功的返回结果，包含指定的数据和主键列表。

参数:

root - 结果集

primaries - 主键列表

返回:

成功的返回结果

querySuccess

public static Result querySuccess(Object root,
 long totalCount,
 int totalPage,
 List<Integer> primaries)

创建一个成功的返回结果，包含指定的数据、总数和总页数，以及主键列表。

参数:

root - 结果集

totalCount - 数据总数

totalPage - 总页数

primaries - 主键列表

返回:

成功的返回结果

success

public static Result success()

创建一个成功的返回结果，不包含数据。

返回:

成功的返回结果

success

public static Result success(ResCode rc,
 String msg)

创建一个成功的返回结果，包含指定的状态码和消息。

参数:

rc - 状态码

msg - 消息

返回:

成功的返回结果

success

public static Result success(Object root)

创建一个成功的返回结果，包含指定的数据。

参数:

root - 数据

返回:

成功的返回结果

success

public static Result success(Object root,
 ResCode rc)

创建一个成功的返回结果，包含指定的数据和状态码。

参数:

root - 数据

rc - 状态码

返回:

成功的返回结果

success

public static Result success(Object root,
 ResCode rc,
 String msg)

创建一个成功的返回结果，包含指定的数据、状态码和消息。

参数:

root - 数据

rc - 状态码

msg - 消息

返回:

成功的返回结果

success

public static Result success(Object root,
 Long totalCount)

创建一个成功的返回结果，包含指定的数据和总数。

参数:

root - 数据

totalCount - 总数

返回:

成功的返回结果

success

public static Result success(org.springframework.data.domain.Page<?> page)

创建一个成功的返回结果，包含指定的分页数据。

参数:

page - 分页数据

返回:

成功的返回结果

fail

public static Result fail()

创建一个失败的返回结果，不包含消息。

返回:

失败的返回结果

fail

public static Result fail(ResCode rc)

创建一个失败的返回结果，包含指定的状态码。

参数:

rc - 状态码

返回:

失败的返回结果

fail

public static Result fail(ResCode rc,
 String msg)

创建一个失败的返回结果，包含指定的状态码和消息。

参数:

rc - 状态码

msg - 消息

返回:

失败的返回结果

fail

public static Result fail(Object root,
 ResCode rc)

创建一个失败的返回结果，包含指定的数据和状态码。

参数:

root - 数据

rc - 状态码

返回:

失败的返回结果

fail

public static Result fail(Object root,
 ResCode rc,
 String msg)

创建一个失败的返回结果，包含指定的数据、状态码和消息。

参数:

root - 数据

rc - 状态码

msg - 消息

返回:

失败的返回结果

fail

public static Result fail(Integer resCode,
 String msg)

创建一个失败的返回结果，包含指定的状态码和消息。

参数:

resCode - 状态码

msg - 消息

返回:

失败的返回结果

exception

public static Result exception(Exception e)

创建一个异常返回结果。

参数:

e - 异常

返回:

异常返回结果