pro.fessional.mirana.data

Class R<T>

java.lang.Object

pro.fessional.mirana.data.R<T>

Type Parameters:

T - Data Type

All Implemented Interfaces:

Serializable, DataResult<T>, I18nAware

Direct Known Subclasses:

PageResult, R.Immutable

public class R<T>
extends Object
implements DataResult<T>, I18nAware

 Basic result container.
 * `success` - whether the operation succeeded or failed.
 * `message` - message to the user.
 * `code` - business code. Note CodeEnum auto set the code.
 * `data` - business data to use if available.

 The following are `@Transient`, should ignore for `hashCode`, `equals` and `json`
 * `cause` - Internal error for tracking. Such as exceptions, strings, enum, etc.
 * `i18nCode`/`i18nArgs` - I18N messages instead of `message`.

 kryo - ignore transient field
 jackson - ignore transient field and @Transient method
 fastjson - ignore transient field

 When using the`cast*` method, be careful to avoid the ClassCastException.

 should NOT use `@Transient` on any serial method, or jackson will ignore this properties,
 see POJOPropertiesCollector#_removeUnwantedProperties and POJOPropertyBuilder#anyIgnorals
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	R.Immutable<T> throw UnsupportedOperationException if modify

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	cause
protected String	code
protected Object	data
protected Object[]	i18nArgs
protected String	i18nCode
protected String	message
protected boolean	success

Constructor Summary

Constructors

Modifier	Constructor and Description
	R()
	R(boolean success)
protected	R(boolean success, CodeEnum code, T data)
protected	R(boolean success, String message, String code, T data)

Method Summary

Modifier and Type	Method and Description
<S extends R<D>,D> S	castData(D data) replace the data and force to cast to subclass
<S extends R<D>,D> S	castData(Function<T,D> fun) replace the data and force to cast to subclass
<S extends R<D>,D> S	castType() force to cast to subclass
boolean	equals(Object o)
@Nullable Object	getCause()
<E> E	getCause(Class<E> type)
@Nullable String	getCode() the biz code to caller
T	getData() the biz data to caller
@Nullable Object[]	getI18nArgs() get i18n args for template
@Nullable String	getI18nCode() get i18n code
@Nullable String	getI18nHint() default message or template
@Nullable String	getMessage() the message to the user
int	hashCode()
boolean	isSuccess() whether success, default false.
static <T> R<T>	ng()
static <T> R<T>	NG()
static <T> R<T>	ng(CodeEnum code)
static <T> R<T>	ng(CodeEnum code, T data)
static <T,S extends R<T>> S	ng(S sr)
static <T,S extends R<T>> S	ng(S sr, CodeEnum code)
static <T,S extends R<T>> S	ng(S sr, CodeEnum code, T data)
static <T,S extends R<T>> S	ng(S sr, String message)
static <T,S extends R<T>> S	ng(S sr, String message, String code)
static <T,S extends R<T>> S	ng(S sr, String message, String code, T data)
static <T,S extends R<T>> S	ng(S sr, Throwable t)
static <T,S extends R<T>> S	ng(S sr, Throwable t, CodeEnum code)
static <T,S extends R<T>> S	ng(S sr, Throwable t, String code)
static <T,S extends R<T>> S	ng(S sr, Throwable t, String code, String message)
static <T> R<T>	ng(String message)
static <T> R<T>	ng(String message, String code)
static <T> R<T>	ng(String message, String code, T data)
static <T> R<T>	ng(Throwable t)
static <T> R<T>	ng(Throwable t, CodeEnum code)
static <T> R<T>	ng(Throwable t, String code)
static <T> R<T>	ng(Throwable t, String code, String message)
static <T> R<T>	ngCode(CodeEnum code, String message)
static <T,S extends R<T>> S	ngCode(S sr, CodeEnum code, String message)
static <T,S extends R<T>> S	ngCode(S sr, String code)
static <T,S extends R<T>> S	ngCode(S sr, String code, String message)
static <T> R<T>	ngCode(String code)
static <T> R<T>	ngCode(String code, String message)
static <T,S extends R<T>> S	ngData(S sr, T data)
static <T,S extends R<T>> S	ngData(S sr, T data, CodeEnum code)
static <T,S extends R<T>> S	ngData(S sr, T data, String code)
static <T,S extends R<T>> S	ngData(S sr, T data, Throwable t)
static <T> R<T>	ngData(T data)
static <T> R<T>	ngData(T data, CodeEnum code)
static <T> R<T>	ngData(T data, String code)
static <T> R<T>	ngData(T data, Throwable t)
static <T> R<T>	of(boolean success)
static <T> R<T>	of(boolean success, CodeEnum code)
static <T> R<T>	of(boolean success, CodeEnum code, String message, T data)
static <T> R<T>	of(boolean success, CodeEnum code, T data)
static <T> R<T>	of(boolean success, String message)
static <T> R<T>	of(boolean success, String message, String code)
static <T> R<T>	of(boolean success, String message, String code, T data)
static <T> R<T>	ok()
static <T> R<T>	OK()
static <T> R<T>	ok(CodeEnum code)
static <T> R<T>	ok(CodeEnum code, T data)
static <T> R<T>	ok(String message)
static <T> R<T>	ok(String message, String code, T data)
static <T> R<T>	ok(String message, T data)
static <T> R<T>	okCode(CodeEnum code, String message)
static <T> R<T>	okCode(String code)
static <T> R<T>	okCode(String code, String message)
static <T> R<T>	okData(T data)
static <T> R<T>	okData(T data, String code)
static <T> R<T>	orCode(boolean success, CodeEnum okCode, CodeEnum ngCode)
static <T> R<T>	orCode(boolean success, String okCode, String ngCode)
static <T> R<T>	orData(boolean success, T okData, T ngData)
static <T> R<T>	orMessage(boolean success, String okMessage, String ngMessage)
R<T>	setCause(Object cause)
R<T>	setCode(CodeEnum code)
R<T>	setCode(String code)
R<T>	setCodeIfNg(CodeEnum code)
R<T>	setCodeIfNg(String code)
R<T>	setCodeIfNg(@NotNull Supplier<CodeEnum> code)
R<T>	setCodeIfOk(CodeEnum code)
R<T>	setCodeIfOk(String code)
R<T>	setCodeIfOk(@NotNull Supplier<CodeEnum> code)
R<T>	setData(T data)
R<T>	setDataIfNg(@NotNull Supplier<T> data)
R<T>	setDataIfNg(T data)
R<T>	setDataIfOk(@NotNull Supplier<T> data)
R<T>	setDataIfOk(T data)
R<T>	setI18nMessage(Boolean replace, CodeEnum ce, Object... arg) set i18nCode and i18nArgs.
R<T>	setI18nMessage(Boolean replace, I18nAware message) set i18nCode and i18nArgs.
R<T>	setI18nMessage(CodeEnum ce, Object... arg) set i18nCode and i18nArgs.
R<T>	setI18nMessage(I18nAware message) set i18nCode and i18nArgs.
R<T>	setI18nMessage(String i18nCode, Object... args)
R<T>	setI18nMessageIfNg(Boolean replace, CodeEnum ce, Object... arg)
R<T>	setI18nMessageIfNg(Boolean replace, I18nAware message)
R<T>	setI18nMessageIfNg(Boolean replace, Supplier<I18nAware> message)
R<T>	setI18nMessageIfNg(CodeEnum ce, Object... arg)
R<T>	setI18nMessageIfNg(I18nAware message)
R<T>	setI18nMessageIfNg(String i18nCode, Object... arg)
R<T>	setI18nMessageIfNg(Supplier<I18nAware> message)
R<T>	setI18nMessageIfOk(Boolean replace, CodeEnum ce, Object... arg)
R<T>	setI18nMessageIfOk(Boolean replace, I18nAware message)
R<T>	setI18nMessageIfOk(Boolean replace, Supplier<I18nAware> message)
R<T>	setI18nMessageIfOk(CodeEnum ce, Object... arg)
R<T>	setI18nMessageIfOk(I18nAware message)
R<T>	setI18nMessageIfOk(String i18nCode, Object... arg)
R<T>	setI18nMessageIfOk(Supplier<I18nAware> message)
R<T>	setMessage(String message)
R<T>	setMessageIfNg(String message)
R<T>	setMessageIfNg(@NotNull Supplier<String> message)
R<T>	setMessageIfOk(String message)
R<T>	setMessageIfOk(@NotNull Supplier<String> message)
R<T>	setSuccess(boolean success)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pro.fessional.mirana.data.DataResult

hasData, hasMessage

Methods inherited from interface pro.fessional.mirana.i18n.I18nAware

toI18nString, toI18nString, toI18nString, toI18nStringArgs

Field Detail

success

protected boolean success

message

protected String message

code

protected String code

data

protected Object data

cause

protected Object cause

i18nCode

protected String i18nCode

i18nArgs

protected Object[] i18nArgs

Constructor Detail

R

public R()

R

public R(boolean success)

R

protected R(boolean success,
            String message,
            String code,
            T data)

R

protected R(boolean success,
            CodeEnum code,
            T data)

Method Detail

isSuccess

public boolean isSuccess()

Description copied from interface: DataResult

whether success, default false.

Specified by:

isSuccess in interface DataResult<T>

setSuccess

@Contract(value="_->this")
public R<T> setSuccess(boolean success)

getMessage

@Nullable
public @Nullable String getMessage()

Description copied from interface: DataResult

the message to the user

Specified by:

getMessage in interface DataResult<T>

setMessage

@Contract(value="_->this")
public R<T> setMessage(String message)

setMessageIfOk

@Contract(value="_->this")
public R<T> setMessageIfOk(String message)

setMessageIfNg

@Contract(value="_->this")
public R<T> setMessageIfNg(String message)

setMessageIfOk

@Contract(value="_->this")
public R<T> setMessageIfOk(@NotNull
                                                      @NotNull Supplier<String> message)

setMessageIfNg

@Contract(value="_->this")
public R<T> setMessageIfNg(@NotNull
                                                      @NotNull Supplier<String> message)

setI18nMessage

@Contract(value="_,_->this")
public R<T> setI18nMessage(CodeEnum ce,
                                                        Object... arg)

set i18nCode and i18nArgs. replace code and message only if it absent

setI18nMessage

@Contract(value="_,_,_->this")
public R<T> setI18nMessage(Boolean replace,
                                                          CodeEnum ce,
                                                          Object... arg)

 set i18nCode and i18nArgs.
 replace code and message if replace is
 - null - absent
 - true - both
 - false - none
 

setI18nMessageIfOk

@Contract(value="_,_->this")
public R<T> setI18nMessageIfOk(CodeEnum ce,
                                                            Object... arg)

setI18nMessageIfNg

@Contract(value="_,_->this")
public R<T> setI18nMessageIfNg(CodeEnum ce,
                                                            Object... arg)

setI18nMessageIfOk

@Contract(value="_,_,_->this")
public R<T> setI18nMessageIfOk(Boolean replace,
                                                              CodeEnum ce,
                                                              Object... arg)

setI18nMessageIfNg

@Contract(value="_,_,_->this")
public R<T> setI18nMessageIfNg(Boolean replace,
                                                              CodeEnum ce,
                                                              Object... arg)

setI18nMessage

@Contract(value="_->this")
public R<T> setI18nMessage(I18nAware message)

set i18nCode and i18nArgs. replace message only if it absent

setI18nMessage

@Contract(value="_,_->this")
public R<T> setI18nMessage(Boolean replace,
                                                        I18nAware message)

 set i18nCode and i18nArgs.
 replace code and message if replace is
 - null - absent
 - true - both
 - false - none
 

setI18nMessageIfOk

@Contract(value="_->this")
public R<T> setI18nMessageIfOk(I18nAware message)

setI18nMessageIfNg

@Contract(value="_->this")
public R<T> setI18nMessageIfNg(I18nAware message)

setI18nMessageIfOk

@Contract(value="_->this")
public R<T> setI18nMessageIfOk(Supplier<I18nAware> message)

setI18nMessageIfNg

@Contract(value="_->this")
public R<T> setI18nMessageIfNg(Supplier<I18nAware> message)

setI18nMessageIfOk

@Contract(value="_,_->this")
public R<T> setI18nMessageIfOk(Boolean replace,
                                                            I18nAware message)

setI18nMessageIfNg

@Contract(value="_,_->this")
public R<T> setI18nMessageIfNg(Boolean replace,
                                                            I18nAware message)

setI18nMessageIfOk

@Contract(value="_,_->this")
public R<T> setI18nMessageIfOk(Boolean replace,
                                                            Supplier<I18nAware> message)

setI18nMessageIfNg

@Contract(value="_,_->this")
public R<T> setI18nMessageIfNg(Boolean replace,
                                                            Supplier<I18nAware> message)

setI18nMessage

@Contract(value="_,_->this")
public R<T> setI18nMessage(String i18nCode,
                                                        Object... args)

setI18nMessageIfOk

@Contract(value="_,_->this")
public R<T> setI18nMessageIfOk(String i18nCode,
                                                            Object... arg)

setI18nMessageIfNg

@Contract(value="_,_->this")
public R<T> setI18nMessageIfNg(String i18nCode,
                                                            Object... arg)

getData

@Nullable
public T getData()

Description copied from interface: DataResult

the biz data to caller

Specified by:

getData in interface DataResult<T>

setData

@Contract(value="_->this")
public R<T> setData(T data)

setDataIfOk

@Contract(value="_->this")
public R<T> setDataIfOk(T data)

setDataIfNg

@Contract(value="_->this")
public R<T> setDataIfNg(T data)

setDataIfOk

@Contract(value="_->this")
public R<T> setDataIfOk(@NotNull
                                                   @NotNull Supplier<T> data)

setDataIfNg

@Contract(value="_->this")
public R<T> setDataIfNg(@NotNull
                                                   @NotNull Supplier<T> data)

getCode

@Nullable
public @Nullable String getCode()

Description copied from interface: DataResult

the biz code to caller

Specified by:

getCode in interface DataResult<T>

setCode

@Contract(value="_->this")
public R<T> setCode(String code)

setCodeIfOk

@Contract(value="_->this")
public R<T> setCodeIfOk(String code)

setCodeIfNg

@Contract(value="_->this")
public R<T> setCodeIfNg(String code)

setCode

@Contract(value="_->this")
public R<T> setCode(CodeEnum code)

setCodeIfOk

@Contract(value="_->this")
public R<T> setCodeIfOk(CodeEnum code)

setCodeIfNg

@Contract(value="_->this")
public R<T> setCodeIfNg(CodeEnum code)

setCodeIfOk

@Contract(value="_->this")
public R<T> setCodeIfOk(@NotNull
                                                   @NotNull Supplier<CodeEnum> code)

setCodeIfNg

@Contract(value="_->this")
public R<T> setCodeIfNg(@NotNull
                                                   @NotNull Supplier<CodeEnum> code)

getCause

@Nullable
public @Nullable Object getCause()

getCause

@Nullable
public <E> E getCause(Class<E> type)

setCause

@Contract(value="_->this")
public R<T> setCause(Object cause)

getI18nCode

@Nullable
public @Nullable String getI18nCode()

Description copied from interface: I18nAware

get i18n code

Specified by:

getI18nCode in interface I18nAware

getI18nArgs

@Nullable
public @Nullable Object[] getI18nArgs()

Description copied from interface: I18nAware

get i18n args for template

Specified by:

getI18nArgs in interface I18nAware

getI18nHint

@Nullable
public @Nullable String getI18nHint()

Description copied from interface: I18nAware

default message or template

Specified by:

getI18nHint in interface I18nAware

castType

@Contract(value="->this")
public <S extends R<D>,D> S castType()

force to cast to subclass

Type Parameters:

S - subclass type

D - data type

Throws:

ClassCastException - if type not match

castData

@Contract(value="_->this")
public <S extends R<D>,D> S castData(D data)

replace the data and force to cast to subclass

Type Parameters:

S - subclass type

D - data type

Parameters:

data - new data

Throws:

ClassCastException - if type not match

castData

@Contract(value="_->this")
public <S extends R<D>,D> S castData(Function<T,D> fun)

replace the data and force to cast to subclass

Type Parameters:

S - subclass type

D - new type

Parameters:

fun - type convertor

Throws:

ClassCastException - if type not match

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

orMessage

public static <T> R<T> orMessage(boolean success,
                                 String okMessage,
                                 String ngMessage)

orCode

public static <T> R<T> orCode(boolean success,
                              CodeEnum okCode,
                              CodeEnum ngCode)

orCode

public static <T> R<T> orCode(boolean success,
                              String okCode,
                              String ngCode)

orData

public static <T> R<T> orData(boolean success,
                              T okData,
                              T ngData)

of

public static <T> R<T> of(boolean success)

of

public static <T> R<T> of(boolean success,
                          String message)

of

public static <T> R<T> of(boolean success,
                          CodeEnum code)

of

public static <T> R<T> of(boolean success,
                          String message,
                          String code)

of

public static <T> R<T> of(boolean success,
                          String message,
                          String code,
                          T data)

of

public static <T> R<T> of(boolean success,
                          CodeEnum code,
                          T data)

of

public static <T> R<T> of(boolean success,
                          CodeEnum code,
                          String message,
                          T data)

OK

public static <T> R<T> OK()

ok

public static <T> R<T> ok()

ok

public static <T> R<T> ok(String message)

ok

public static <T> R<T> ok(CodeEnum code)

ok

public static <T> R<T> ok(String message,
                          T data)

ok

public static <T> R<T> ok(String message,
                          String code,
                          T data)

ok

public static <T> R<T> ok(CodeEnum code,
                          T data)

okCode

public static <T> R<T> okCode(String code)

okCode

public static <T> R<T> okCode(String code,
                              String message)

okCode

public static <T> R<T> okCode(CodeEnum code,
                              String message)

okData

public static <T> R<T> okData(T data)

okData

public static <T> R<T> okData(T data,
                              String code)

NG

public static <T> R<T> NG()

ng

public static <T> R<T> ng()

ng

public static <T> R<T> ng(String message)

ng

public static <T> R<T> ng(CodeEnum code)

ng

public static <T> R<T> ng(String message,
                          String code)

ng

public static <T> R<T> ng(String message,
                          String code,
                          T data)

ng

public static <T> R<T> ng(CodeEnum code,
                          T data)

ngCode

public static <T> R<T> ngCode(String code)

ngCode

public static <T> R<T> ngCode(String code,
                              String message)

ngCode

public static <T> R<T> ngCode(CodeEnum code,
                              String message)

ngData

public static <T> R<T> ngData(T data)

ngData

public static <T> R<T> ngData(T data,
                              String code)

ngData

public static <T> R<T> ngData(T data,
                              Throwable t)

ngData

public static <T> R<T> ngData(T data,
                              CodeEnum code)

ng

public static <T> R<T> ng(Throwable t)

ng

public static <T> R<T> ng(Throwable t,
                          String code)

ng

public static <T> R<T> ng(Throwable t,
                          String code,
                          String message)

ng

public static <T> R<T> ng(Throwable t,
                          CodeEnum code)

ng

public static <T,S extends R<T>> S ng(S sr)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      String message)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      CodeEnum code)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      String message,
                                      String code)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      String message,
                                      String code,
                                      T data)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      CodeEnum code,
                                      T data)

ngCode

public static <T,S extends R<T>> S ngCode(S sr,
                                          String code)

ngCode

public static <T,S extends R<T>> S ngCode(S sr,
                                          String code,
                                          String message)

ngCode

public static <T,S extends R<T>> S ngCode(S sr,
                                          CodeEnum code,
                                          String message)

ngData

public static <T,S extends R<T>> S ngData(S sr,
                                          T data)

ngData

public static <T,S extends R<T>> S ngData(S sr,
                                          T data,
                                          String code)

ngData

public static <T,S extends R<T>> S ngData(S sr,
                                          T data,
                                          Throwable t)

ngData

public static <T,S extends R<T>> S ngData(S sr,
                                          T data,
                                          CodeEnum code)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      Throwable t)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      Throwable t,
                                      String code)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      Throwable t,
                                      String code,
                                      String message)

ng

public static <T,S extends R<T>> S ng(S sr,
                                      Throwable t,
                                      CodeEnum code)