程序包 cn.dinodev.spring.commons.response

接口 Status

所有已知实现类:

Status.CODE

public interface Status

响应状态码及msg

作者:

Cody Lu

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static enum	Status.CODE

方法概要

修饰符和类型	方法	说明
static Status	fail(int code, String msg)	生成失败Status
static Status	fail(int code, String msg, Object... args)	生成失败Status, 并对错误消息进行参数化，如：fail(-1, "参数{}不能为空", "name")
static Status	fail(String msg)	生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR
static Status	fail(String msg, Object... args)	生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR 如：fail("参数{}不能为空", "name")
int	getCode()	获取状态码
String	getMsg()	获取错误消息
static Status	invalidParam(String msg)	生成参数错误Status
static Status	invalidParam(String msg, Object... args)	生成失败Status, 并对错误消息进行参数化，如：invalidParam(-1, "参数{}不能为空", "name")
static Status	ok()	生成成功Status
static Status	ok(String msg)	生成成功Status
Status	withMsg(String msg)	替换消息
Status	withMsg(String msg, Object... args)	替换消息信息

方法详细资料

getCode

int getCode()

获取状态码

返回:

getMsg

String getMsg()

获取错误消息

返回:

withMsg

Status withMsg(@Nonnull
 String msg)

替换消息

参数:

msg - 消息信息

返回:

withMsg

Status withMsg(@Nonnull
 String msg,
 Object... args)

替换消息信息

参数:

msg - 消息模板，'{}'为参数占位符，例如："user {} not found"

args - 消息模板的参数

返回:

ok

static Status ok()

生成成功Status

返回:

ok

static Status ok(@Nonnull
 String msg)

生成成功Status

参数:

msg - 错误消息

返回:

fail

static Status fail(@Nonnull
 String msg)

生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR

参数:

msg - 错误消息

返回:

fail

static Status fail(@Nonnull
 String msg,
 Object... args)

生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR 如：fail("参数{}不能为空", "name")

参数:

msg - 错误消息，用MessageFormatter 进行格式化

args - 消息格式化参数

返回:

fail

static Status fail(int code,
 @Nonnull
 String msg)

生成失败Status

参数:

code - 状态码

msg - 错误消息

返回:

fail

static Status fail(int code,
 @Nonnull
 String msg,
 Object... args)

生成失败Status, 并对错误消息进行参数化，如：fail(-1, "参数{}不能为空", "name")

参数:

code - 状态码

msg - 错误消息，用MessageFormatter 进行格式化

args - 消息格式化参数

返回:

invalidParam

static Status invalidParam(@Nonnull
 String msg)

生成参数错误Status

参数:

msg - 错误消息

返回:

invalidParam

static Status invalidParam(@Nonnull
 String msg,
 Object... args)

生成失败Status, 并对错误消息进行参数化，如：invalidParam(-1, "参数{}不能为空", "name")

参数:

msg - 错误消息，用MessageFormatter 进行格式化

args - 消息格式化参数

返回: