类的使用
com.easycodebox.common.error.CodeMsg

使用CodeMsg的程序包

程序包	说明
com.easycodebox.common.api
com.easycodebox.common.error
com.easycodebox.common.file
com.easycodebox.common.jackson
com.easycodebox.common.validate
com.easycodebox.common.web
com.easycodebox.common.web.callback

com.easycodebox.common.api中CodeMsg的使用

返回CodeMsg的com.easycodebox.common.api中的方法

限定符和类型	方法和说明
CodeMsg	SendApiAdapter.receive(Map<String,Object> params, javax.servlet.http.HttpServletRequest request)
CodeMsg	ApiAdapter.receive(Map<String,Object> params, javax.servlet.http.HttpServletRequest request) 处理API接口的逻辑
CodeMsg	Api.receive(Map<String,Object> params, javax.servlet.http.HttpServletRequest request) 接受API请求
CodeMsg	ReceiveApiAdapter.send(Map<String,Object> params)
CodeMsg	ApiAdapter.send(Map<String,Object> params)
CodeMsg	Api.send(Map<String,Object> params) 发送API请求

com.easycodebox.common.error中CodeMsg的使用

声明为CodeMsg的com.easycodebox.common.error中的字段

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

返回CodeMsg的com.easycodebox.common.error中的方法

限定符和类型	方法和说明
CodeMsg	CodeMsg.code(String code) 设置code。
CodeMsg	CodeMsg.codeMsg(String code, String msg, Object... args) 同时设置code、msg
CodeMsg	CodeMsg.copy()
CodeMsg	CodeMsg.data(Object data) 设置额外的数据。
CodeMsg	CodeMsg.fillArgs(Object... args) 把args填充到msg中。
CodeMsg	ErrorContext.getError()
static CodeMsg	CodeMsg.CodeMsgUtils.json2Bean(String json)
static CodeMsg	CodeMsg.CodeMsgUtils.json2Bean(String json, Class<?> dataValueType)
static CodeMsg	CodeMsg.CodeMsgUtils.json2Bean(String json, com.fasterxml.jackson.databind.JavaType dataValueType)
static CodeMsg	CodeMsg.CodeMsgUtils.json2Bean(String json, com.fasterxml.jackson.core.type.TypeReference<?> dataValueTypeRef)
CodeMsg	CodeMsg.msg(String msg, Object... args) 设置msg。

参数类型为CodeMsg的com.easycodebox.common.error中的方法

限定符和类型	方法和说明
ErrorContext	ErrorContext.error(CodeMsg error)
static ErrorContext	ErrorContext.instance(CodeMsg error, Object... args)
static ErrorContext	ErrorContext.instance(CodeMsg error, Throwable cause, Object... args)

类型变量类型为CodeMsg的com.easycodebox.common.error中的方法参数

限定符和类型	方法和说明
static void	CodeMsg.CodeMsgUtils.storePropertiesFile(Class<? extends CodeMsg> clazz, File propertiesFile) code/msg存储到Properties文件中

参数类型为CodeMsg的com.easycodebox.common.error中的构造器

构造器和说明
ErrorContext(CodeMsg error, Throwable cause)

com.easycodebox.common.file中CodeMsg的使用

返回CodeMsg的com.easycodebox.common.file中的方法

限定符和类型	方法和说明
static CodeMsg	FileUtils.validate(String rules, InputStream[] iss, String[] filenames, long[] fileSizes, Integer maxSize, boolean transaction) 注意：需要手动释放InputStream资源 返回"suc"验证成功，除此之外都为验证失败 sl(8) ==> 大小(size)小于等于8M sg(8) ==> 大小(size)大于等于8M type(jpg,png) ==> 文件格式 只能为jpg,png
static CodeMsg	ImageTools.validateImgs(String rules, File... imgs)
static CodeMsg	ImageTools.validateImgs(String rules, ImageInputStream[] imgs, long[] fileSizes, Integer maxSize, boolean transaction) 注意：需要手动释放InputStream的资源 返回"suc"验证成功，除此之外都为验证失败 wl(900) ==> 宽度小于等于900px wg(900) ==> 宽度大于等于900px hl(900) ==> 高度小于等于900px hg(900) ==> 高度大于等于900px re(0.5) ==> 比例(ratio)等于0.5（宽/高=0.5），容错比例为0.1 rl(0.5) ==> 比例(ratio)小于等于0.5（宽/高<=0.5） rg(0.5) ==> 比例(ratio)大于等于0.5（宽/高>=0.5） sl(8) ==> 大小(size)小于等于8M sg(8) ==> 大小(size)大于等于8M type(jpg,png) ==> 文件格式 只能为jpg,png
static CodeMsg	ImageTools.validateImgs(String rules, InputStream[] imgs, long[] fileSizes, Integer maxSize, boolean transaction) 注意：需要手动释放InputStream的资源

com.easycodebox.common.jackson中CodeMsg的使用

参数类型为CodeMsg的com.easycodebox.common.jackson中的方法

限定符和类型	方法和说明
void	CodeMsgSerializer.serialize(CodeMsg value, com.fasterxml.jackson.core.JsonGenerator jgen, com.fasterxml.jackson.databind.SerializerProvider provider)

com.easycodebox.common.validate中CodeMsg的使用

返回CodeMsg的com.easycodebox.common.validate中的方法

限定符和类型	方法和说明
CodeMsg	Validators.getError()

参数类型为CodeMsg的com.easycodebox.common.validate中的方法

限定符和类型	方法和说明
static void	Assert.isAssignable(Class superType, Class subType, CodeMsg error)
static void	Assert.isBlank(String text, CodeMsg error)
static void	Assert.isFalse(boolean expression, CodeMsg error)
static void	Assert.isInstanceOf(Class<?> type, Object obj, CodeMsg error)
static void	Assert.isNull(Object object, CodeMsg error)
static void	Assert.isTrue(boolean expression, CodeMsg error)
static void	Assert.length(Object[] array, int length, CodeMsg error)
static void	Assert.noNullElements(Object[] array, CodeMsg error)
static void	Assert.notBlank(String text, CodeMsg error)
static void	Assert.notContain(String textToSearch, String substring, CodeMsg error)
static void	Assert.notEmpty(Collection<?> collection, CodeMsg error)
static void	Assert.notEmpty(Map<?,?> map, CodeMsg error)
static void	Assert.notEmpty(Object[] array, CodeMsg error)
static void	Assert.notNull(Object object, CodeMsg error)

com.easycodebox.common.web中CodeMsg的使用

返回CodeMsg的com.easycodebox.common.web中的方法

限定符和类型	方法和说明
protected CodeMsg	BaseController.isTrue(boolean bool) bool == true return SUC, 否则 return FAIL
protected CodeMsg	BaseController.isTrue(boolean bool, String failMsg, Object... failMsgArgs) bool == true return SUC, 否则 return FAIL 返回FAIL时并设置提示信息
protected CodeMsg	BaseController.isTrueNone(boolean bool) bool == true return NONE, 否则 return FAIL
protected CodeMsg	BaseController.isTrueNone(boolean bool, String failMsg, Object... failMsgArgs) bool == true return NONE, 否则 return FAIL 返回FAIL时并设置提示信息
protected CodeMsg	BaseController.none() return NONE
protected CodeMsg	BaseController.none(Object data) return NONE，并设置data

com.easycodebox.common.web.callback中CodeMsg的使用

com.easycodebox.common.web.callback中CodeMsg的子类

限定符和类型	类和说明
class	CallbackData

参数类型为CodeMsg的com.easycodebox.common.web.callback中的方法

限定符和类型	方法和说明
static CallbackData	Callbacks.closeDialog(CodeMsg error) 关闭对话框后刷新当前的页面，只用于dialog的表单页面
static CallbackData	Callbacks.closeDialogQuiet(CodeMsg error) 关闭对话框后不刷新当前页面，只用于dialog的表单页面
static CallbackData	Callbacks.flushCur(CodeMsg error) 刷新当前页面
static CallbackData	Callbacks.flushHis(CodeMsg error) 刷新上级页面
static CallbackData	CallbackData.instance(CodeMsg codeMsg)
static CallbackData	CallbackData.instance(String action, CodeMsg codeMsg)
static CallbackData	CallbackData.instance(String action, CodeMsg codeMsg, String url)
static CallbackData	Callbacks.none(CodeMsg error) 页面不执行任何动作，弹出信息为msg。
static CallbackData	Callbacks.paramError(CodeMsg error) 获取回调对象，此回调对象为参数错误