CodeMsg (easycode-common 0.2.4 API)

java.lang.Object
- com.easycodebox.common.error.CodeMsg

所有已实现的接口:

Serializable

直接已知子类:

CallbackData
```
public class CodeMsg
extends Object
implements Serializable
```
1. 当code = [SUC_CODE | null] 时，视执行成功。 2. 当返回CodeMsg的对象中msg属性没值，意味着提示信息由客户端自己控制。当有值时，会覆盖客户端定义的提示信息。

作者:

WangXiaoJin

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class CodeMsg.Code
code常量

static class CodeMsg.CodeMsgUtils

static class CodeMsg.Msg
msg常量

嵌套类
限定符和类型	类和说明
`static class`	`CodeMsg.Code` code常量
`static class`	`CodeMsg.CodeMsgUtils`
`static class`	`CodeMsg.Msg` msg常量

字段概要

字段
限定符和类型	字段和说明
`static CodeMsg`	`FAIL` 失败
`static CodeMsg`	`FAIL_MSG` 失败
`static CodeMsg`	`NO_LOGIN` 未登录
`static CodeMsg`	`NONE` 不显示提示信息
`static CodeMsg`	`SUC` 成功
`static CodeMsg`	`SUC_MSG` 成功

构造器概要

构造器
限定符构造器和说明

protected CodeMsg(String code, String msg)

protected CodeMsg(String code, String msg, Object data)

构造器
限定符	构造器和说明
`protected`	`CodeMsg(String code, String msg)`
`protected`	`CodeMsg(String code, String msg, Object data)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CodeMsg`	`code(String code)` 设置code。
`CodeMsg`	`codeMsg(String code, String msg, Object... args)` 同时设置code、msg
`CodeMsg`	`copy()`
`CodeMsg`	`data(Object data)` 设置额外的数据。
`CodeMsg`	`fillArgs(Object... args)` 把args填充到msg中。
`String`	`getCode()` 获取错误信息的code
`Object`	`getData()` 获取存储的数据
`String`	`getMsg()` 获取提示信息
`boolean`	`isSuc()` code == null \|\| code == SUC_CODE 时被视为成功
`CodeMsg`	`msg(String msg, Object... args)` 设置msg。
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

NONE
```
public static CodeMsg NONE
```
不显示提示信息

SUC
```
public static CodeMsg SUC
```
成功

SUC_MSG
```
public static CodeMsg SUC_MSG
```
成功

FAIL
```
public static CodeMsg FAIL
```
失败

FAIL_MSG
```
public static CodeMsg FAIL_MSG
```
失败

NO_LOGIN
```
public static CodeMsg NO_LOGIN
```
未登录

构造器详细资料

CodeMsg

protected CodeMsg(String code,
                  String msg)

CodeMsg

protected CodeMsg(String code,
                  String msg,
                  Object data)

方法详细资料
- code
```
public CodeMsg code(String code)
```
  设置code。返回一个新的CodeMsg对象，不会修改原有的对象只有CodeMsg.SUC_CODE视为成功，其他全为失败
- msg
```
public CodeMsg msg(String msg,
                   Object... args)
```
  设置msg。返回一个新的CodeMsg对象，不会修改原有的对象
  
  参数:
  
  msg -
  
  args - 用于替换msg中的占位符
  
  返回:
- codeMsg
```
public CodeMsg codeMsg(String code,
                       String msg,
                       Object... args)
```
  同时设置code、msg
  
  参数:
  
  code -
  
  msg -
  
  args -
  
  返回:
- fillArgs
```
public CodeMsg fillArgs(Object... args)
```
  把args填充到msg中。如果args有值则返回一个新的CodeMsg对象，不会修改原有的对象
  
  参数:
  
  args -
  
  返回:
- data
```
public CodeMsg data(Object data)
```
  设置额外的数据。返回一个新的CodeMsg对象，不会修改原有的对象
  
  参数:
  
  data -
  
  返回:
- getCode
```
public String getCode()
```
  获取错误信息的code
  
  返回:
- getMsg
```
public String getMsg()
```
  获取提示信息
  
  返回:
- getData
```
public Object getData()
```
  获取存储的数据
  
  返回:
- toString
```
public String toString()
```
  覆盖:
  
  toString 在类中 Object
- copy
```
public CodeMsg copy()
```
- isSuc
```
public boolean isSuc()
```
  code == null || code == SUC_CODE 时被视为成功
  
  参数:
  
  error -
  
  返回:

类 CodeMsg

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

NONE

SUC

SUC_MSG

FAIL

FAIL_MSG

NO_LOGIN

构造器详细资料

CodeMsg

CodeMsg

方法详细资料

code

msg

codeMsg

fillArgs

data

getCode

getMsg

getData

toString

copy

isSuc