模块 org.redkale

程序包 org.redkale.service

类 RetResult<T>

java.lang.Object

org.redkale.service.RetResult<T>

类型参数:

T - 结果对象的泛型

所有已实现的接口:

Serializable

public class RetResult<T>
extends Object
implements Serializable

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

详情见: https://redkale.org

作者:

zhangjx

另请参阅:

序列化表格

字段概要

字段

修饰符和类型	字段	说明
protected Map<String,String>	attach	已过时。
protected Convert	convert
protected T	result
protected int	retcode
protected String	retinfo
static Type	TYPE_RET_INTEGER
static Type	TYPE_RET_LONG
static Type	TYPE_RET_STRING

构造器概要

构造器

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

方法概要

修饰符和类型	方法	说明
RetResult<T>	attach(String key, Object value)	已过时。
RetResult<T>	attach(Map<String,String> attach)	已过时。
RetResult<T>	clearAttach()	已过时。
Convert	clearConvert()
<V> RetResult<V>	clearResult()	清空result
Convert	convert()
RetResult	convert(Convert convert)
boolean	emptyRetinfo()	retinfo值是否为空
static <T> RetResult<T>	fail(int retcode, String retinfo)
static <T> RetResult<T>	fail(RetException ex)
static <T> CompletableFuture<RetResult<T>>	failFuture(int retcode, String retinfo)
static <T> CompletableFuture<RetResult<T>>	failFuture(RetException ex)
static <T> RetResult<T>	get(CompletableFuture<RetResult<T>> future, long timeout, TimeUnit unit)
Map<String,String>	getAttach()	已过时。
String	getAttach(String name, String defValue)	已过时。
T	getResult()	结果对象， 通常只有在retcode = 0时值才有效
int	getRetcode()	结果码 0表示成功、 非0表示错误
String	getRetinfo()	结果信息，通常retcode !
boolean	isSuccess()	判断结果是否成功返回， retcode = 0 视为成功， 否则视为错误码
T	join()
static <K,V> RetResult<Map<K,V>>	map(Object... items)
<R> RetResult<R>	mapTo(Function<T,R> mapper)	将RetResult<X> 转换成一个新的 RetResult<Y>
RetResult<T>	result(T result)	同 setResult
RetResult<T>	retcode(int retcode)	同 setRetcode
RetResult<T>	retinfo(String retinfo)	同 setRetinfo
void	setAttach(Map<String,String> attach)	已过时。
void	setResult(T result)	设置结果对象
void	setRetcode(int retcode)
void	setRetinfo(String retinfo)	设置结果信息
static RetResult	success()
static <T> RetResult<T>	success(T result)
static <T> CompletableFuture<RetResult<T>>	successFuture()
static <T> CompletableFuture<RetResult<T>>	successFuture(T result)
CompletableFuture	toAnyFuture()
CompletableFuture<RetResult<T>>	toFuture()
String	toString()

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

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

字段详细资料

TYPE_RET_INTEGER

public static final Type TYPE_RET_INTEGER

TYPE_RET_LONG

public static final Type TYPE_RET_LONG

TYPE_RET_STRING

public static final Type TYPE_RET_STRING

retcode

@ConvertColumn(index=2)
protected int retcode

retinfo

@ConvertColumn(index=3)
protected String retinfo

result

@ConvertColumn(index=4)
protected T result

attach

@ConvertColumn(index=5)
@Deprecated(since="2.5.0")
protected Map<String,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,
                 String retinfo)

RetResult

public RetResult(int retcode,
                 String retinfo,
                 T result)

方法详细资料

convert

public Convert convert()

clearConvert

public Convert clearConvert()

convert

public RetResult convert(Convert convert)

toFuture

public CompletableFuture<RetResult<T>> toFuture()

toAnyFuture

public CompletableFuture toAnyFuture()

success

public static RetResult success()

success

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

successFuture

public static <T> CompletableFuture<RetResult<T>> successFuture()

successFuture

public static <T> CompletableFuture<RetResult<T>> successFuture(T result)

fail

public static <T> RetResult<T> fail(int retcode,
                                    String retinfo)

fail

public static <T> RetResult<T> fail(RetException ex)

failFuture

public static <T> CompletableFuture<RetResult<T>> failFuture(int retcode,
                                                             String retinfo)

failFuture

public static <T> CompletableFuture<RetResult<T>> failFuture(RetException ex)

join

public T join()

get

public static <T> RetResult<T> get(CompletableFuture<RetResult<T>> future,
                                   long timeout,
                                   TimeUnit unit)

map

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

clearResult

public <V> RetResult<V> clearResult()

清空result

类型参数:

V - V

返回:

RetResult

mapTo

public <R> RetResult<R> mapTo(Function<T,R> mapper)

将RetResult<X> 转换成一个新的 RetResult<Y>

类型参数:

R - 目标数据类型

参数:

mapper - 转换函数

返回:

RetResult

从以下版本开始:

2.1.0

retcode

public RetResult<T> retcode(int retcode)

同 setRetcode

参数:

retcode - retcode

返回:

RetResult

retinfo

public RetResult<T> retinfo(String retinfo)

同 setRetinfo

参数:

retinfo - retinfo

返回:

RetResult

result

public RetResult<T> result(T result)

同 setResult

参数:

result - result

返回:

RetResult

attach

@Deprecated(since="2.5.0")
public RetResult<T> attach(Map<String,String> attach)

已过时。

同 setAttach

参数:

attach - attach

返回:

RetResult

attach

@Deprecated(since="2.5.0")
public RetResult<T> attach(String key,
                           Object value)

已过时。

attach添加元素

参数:

key - String

value - String

返回:

RetResult

clearAttach

@Deprecated(since="2.5.0")
public RetResult<T> clearAttach()

已过时。

清空attach

返回:

RetResult

getRetcode

public int getRetcode()

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

返回:

结果码

setRetcode

public void setRetcode(int retcode)

emptyRetinfo

public boolean emptyRetinfo()

retinfo值是否为空

返回:

是否为空

从以下版本开始:

2.7.0

getRetinfo

public String getRetinfo()

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

返回:

结果信息

setRetinfo

public void setRetinfo(String retinfo)

设置结果信息

参数:

retinfo - 结果信息

getAttach

@Deprecated(since="2.5.0")
public Map<String,String> getAttach()

已过时。

结果附件

返回:

结果附件

setAttach

@Deprecated(since="2.5.0")
public void setAttach(Map<String,String> attach)

已过时。

设置结果附件

参数:

attach - Map

getAttach

@Deprecated(since="2.5.0")
public String getAttach(String name,
                        String defValue)

已过时。

获取附件元素值

参数:

name - 元素名

defValue - 默认值

返回:

结果值

getResult

public T getResult()

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

返回:

结果对象

setResult

public void setResult(T result)

设置结果对象

参数:

result - T

isSuccess

@ConvertColumn(index=1)
public boolean isSuccess()

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

返回:

是否成功

toString

public String toString()

覆盖:

toString 在类中 Object