org.redkale.service

类 RetResult<T>

java.lang.Object

org.redkale.service.RetResult<T>

类型参数:

T - 结果对象的泛型

public class RetResult<T>
extends java.lang.Object

通用的结果对象，在常见的HTTP+JSON接口中返回的结果需要含结果码，错误信息，和实体对象。
结果码定义通常前四位为模块，后四位为操作。
结果码定义范围:
// 10000001 - 19999999 预留给Redkale的核心包使用
// 20000001 - 29999999 预留给Redkale的扩展包使用
// 30000001 - 99999999 预留给Dev开发系统自身使用

详情见: https://redkale.org

字段概要

字段

限定符和类型	字段和说明
protected java.util.Map<java.lang.String,java.lang.String>	attach
protected Convert	convert
protected T	result
protected int	retcode
protected java.lang.String	retinfo

构造器概要

构造器

构造器和说明
RetResult()
RetResult(Convert convert, T result)
RetResult(int retcode)
RetResult(int retcode, java.lang.String retinfo)
RetResult(int retcode, java.lang.String retinfo, T result)
RetResult(T result)

方法概要

限定符和类型	方法和说明
RetResult<T>	attach(java.util.Map<java.lang.String,java.lang.String> attach) 同 setAttach
RetResult<T>	attach(java.lang.String key, java.lang.Object value) attach添加元素
RetResult<T>	clearAttach() 清空attach
Convert	convert()
void	convert(Convert convert)
java.util.Map<java.lang.String,java.lang.String>	getAttach() 结果附件
java.lang.String	getAttach(java.lang.String name, java.lang.String defValue) 获取附件元素值
T	getResult() 结果对象， 通常只有在retcode = 0时值才有效
int	getRetcode() 结果码 0表示成功、 非0表示错误
java.lang.String	getRetinfo() 结果信息，通常retcode !
boolean	isSuccess() 判断结果是否成功返回， retcode = 0 视为成功， 否则视为错误码
static <K,V> RetResult<java.util.Map<K,V>>	map(java.lang.Object... items)
static RetResult<java.util.Map<java.lang.String,java.lang.String>>	map(java.lang.String... items)
RetResult<T>	result(T result) 同 setResult
RetResult<T>	retcode(int retcode) 同 setRetcode
RetResult<T>	retinfo(java.lang.String retinfo) 同 setRetinfo
void	setAttach(java.util.Map<java.lang.String,java.lang.String> attach) 设置结果附件
void	setResult(T result) 设置结果对象
void	setRetcode(int retcode)
void	setRetinfo(java.lang.String retinfo) 设置结果信息
static RetResult	success()
static <T> RetResult<T>	success(T result)
static <T> java.util.concurrent.CompletableFuture<RetResult<T>>	successFuture()
java.lang.String	toString()

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

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

字段详细资料

retcode

protected int retcode

retinfo

protected java.lang.String retinfo

result

protected T result

attach

protected java.util.Map<java.lang.String,java.lang.String> attach

convert

protected Convert convert

构造器详细资料

RetResult

public RetResult()

RetResult

public RetResult(T result)

RetResult

public RetResult(Convert convert,
                 T result)

RetResult

public RetResult(int retcode)

RetResult

public RetResult(int retcode,
                 java.lang.String retinfo)

RetResult

public RetResult(int retcode,
                 java.lang.String retinfo,
                 T result)

方法详细资料

convert

public Convert convert()

convert

public void convert(Convert convert)

success

public static RetResult success()

success

public static <T> RetResult<T> success(T result)

successFuture

public static <T> java.util.concurrent.CompletableFuture<RetResult<T>> successFuture()

map

public static RetResult<java.util.Map<java.lang.String,java.lang.String>> map(java.lang.String... items)

map

public static <K,V> RetResult<java.util.Map<K,V>> map(java.lang.Object... items)

isSuccess

public boolean isSuccess()

判断结果是否成功返回， retcode = 0 视为成功， 否则视为错误码

返回:

是否成功

retcode

public RetResult<T> retcode(int retcode)

同 setRetcode

参数:

retcode - retcode

返回:

RetResult

retinfo

public RetResult<T> retinfo(java.lang.String retinfo)

同 setRetinfo

参数:

retinfo - retinfo

返回:

RetResult

result

public RetResult<T> result(T result)

同 setResult

参数:

result - result

返回:

RetResult

attach

public RetResult<T> attach(java.util.Map<java.lang.String,java.lang.String> attach)

同 setAttach

参数:

attach - attach

返回:

RetResult

attach

public RetResult<T> attach(java.lang.String key,
                           java.lang.Object value)

attach添加元素

参数:

key - String

value - String

返回:

RetResult

clearAttach

public RetResult<T> clearAttach()

清空attach

返回:

RetResult

getRetcode

public int getRetcode()

结果码 0表示成功、 非0表示错误

返回:

结果码

setRetcode

public void setRetcode(int retcode)

getRetinfo

public java.lang.String getRetinfo()

结果信息，通常retcode != 0时值为错误信息

返回:

结果信息

setRetinfo

public void setRetinfo(java.lang.String retinfo)

设置结果信息

参数:

retinfo - 结果信息

getResult

public T getResult()

结果对象， 通常只有在retcode = 0时值才有效

返回:

结果对象

setResult

public void setResult(T result)

设置结果对象

参数:

result - T

getAttach

public java.util.Map<java.lang.String,java.lang.String> getAttach()

结果附件

返回:

结果附件

getAttach

public java.lang.String getAttach(java.lang.String name,
                                  java.lang.String defValue)

获取附件元素值

参数:

name - 元素名

defValue - 默认值

返回:

结果值

setAttach

public void setAttach(java.util.Map<java.lang.String,java.lang.String> attach)

设置结果附件

参数:

attach - Map

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object