pro.fessional.mirana.data

Class R<T>

java.lang.Object

pro.fessional.mirana.i18n.I18nMessage

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

Type Parameters:

T - Data Type

All Implemented Interfaces:

Serializable, ChainingCast, CodeAware, DataAware<T>, DataResult<T>, DoneAware, ErrorResult, I18nAware

Direct Known Subclasses:

PageResult, R.Immutable

public class R<T>
extends I18nMessage
implements DataResult<T>, ErrorResult, I18nAware

 ## Conventions

 1. ErrorResult with errors -  the service is abnormal and incomplete.
 1.1. success - must be false.
 1.2. if has i18n-message - should be the 1st error message.
 1.3. if has code - the err-code to clarify the detailed error.
 2. DataResult without errors - the service is normal and complete.
 2.1. success - can be true or false.
 2.2. if has i18n-message -  give more information to the user.
 2.3. if has code - the biz-code to clarify the detailed data.
 2.4. if has data - the biz-data to the user, regardless of success.

 ## Basic result container.

 - success - whether the result succeeded, default false.
 - code - biz/err code. CodeEnum auto set the code.
 - data - business data in the result.
 - errors - errors thrown, success must be false.
 - message - default i18n message or template
 - i18nCode - i18n template code
 - i18nArgs - i18n template args

 ## serialize and @Transient

 The following are `@Transient`, should ignore for `hashCode`, `equals` and `json`
 - `cause` - Internal error for tracking. Such as exceptions, strings, enum, etc.

 `@Transient` and `transient` are difference,
 - kryo - ignore transient field
 - jackson - ignore transient field and @Transient method
 - fastjson - ignore transient field

 NOTE-1: should NOT use `@Transient` on any setter-like method, or jackson will ignore properties by name,
 e.g. setXxx or getXxx will ignore the xxx property, the param list are not considered,
 check POJOPropertiesCollector#_removeUnwantedProperties
 and POJOPropertyBuilder#anyIgnorals

 NOTE-2: When using the`cast*` method, be careful to avoid the ClassCastException.

 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface pro.fessional.mirana.i18n.I18nAware

I18nAware.I18nSource

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	cause
protected String	code
protected Object	data
protected List<I18nNotice>	errors
protected boolean	success

Fields inherited from class pro.fessional.mirana.i18n.I18nMessage

i18nArgs, i18nCode, message

Constructor Summary

Constructors

Constructor and Description
R()
R(boolean success)
R(boolean success, T data)
R(boolean success, T data, CodeEnum code)
R(boolean success, T data, I18nAware message)
R(boolean success, T data, String code)
R(boolean success, T data, String code, I18nAware message)
R(boolean success, T data, String code, String message)
R(boolean success, T data, String code, String message, String i18nCode)
R(boolean success, T data, String code, String message, String i18nCode, Object... i18nArgs)
R(I18nNotice err)
R(List<I18nNotice> errs)

Method Summary

Modifier and Type	Method and Description
void	applyLocale(Locale locale, @NotNull I18nAware.I18nSource source) apply the internal locale and updates the i18n state based on the provided source.
<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
boolean	equals(Object o)
@Nullable Object	getCause()
<E> E	getCause(Class<E> type)
String	getCode()
T	getData() the biz-data to caller
@Nullable List<I18nNotice>	getErrors() errors cause success to be false, should be null if empty.
int	hashCode()
boolean	isSuccess() whether success, default false.
static <T> R<T>	ng()
static <T> R<T>	NG()
static <T> R<T>	ng(T data)
static <T> R<T>	ng(T data, CodeEnum code)
static <T> R<T>	ng(T data, I18nAware code)
static <T> R<T>	ng(T data, String code)
static <T> R<T>	ng(T data, String code, I18nAware message)
static <T> R<T>	ng(T data, String code, String message)
static <T> R<T>	ngCause(Throwable t)
static <T> R<T>	ngCause(Throwable t, CodeEnum code)
static <T> R<T>	ngCause(Throwable t, I18nAware message)
static <T> R<T>	ngCause(Throwable t, String code)
static <T> R<T>	ngCause(Throwable t, String code, I18nAware message)
static <T> R<T>	ngCause(Throwable t, String code, String message)
static <T> R<T>	ngCode(CodeEnum code)
static <T> R<T>	ngCode(String code)
static <T> R<T>	ngCodeMessage(CodeEnum code)
static <T> R<T>	ngError(I18nNotice error)
static <T> R<T>	ngError(I18nNotice error, String code)
static <T> R<T>	ngError(List<I18nNotice> errors)
static <T> R<T>	ngError(List<I18nNotice> errors, String code)
static <T> R<T>	ngError(Throwable t, String type)
static <T> R<T>	ngMessage(I18nAware message)
static <T> R<T>	ngMessage(String message)
static <T> R<T>	of(boolean success)
static <T> R<T>	of(boolean success, T data)
static <T> R<T>	of(boolean success, T data, CodeEnum code)
static <T> R<T>	of(boolean success, T data, I18nAware message)
static <T> R<T>	of(boolean success, T data, String code)
static <T> R<T>	of(boolean success, T data, String code, I18nAware message)
static <T> R<T>	of(boolean success, T data, String code, String message)
static <T> R<T>	ofCode(boolean success, CodeEnum code)
static <T> R<T>	ofCode(boolean success, String code)
static <T> R<T>	ofCodeMessage(boolean success, CodeEnum code)
static <T> R<T>	ofMessage(boolean success, I18nAware message)
static <T> R<T>	ofMessage(boolean success, String message)
static <T> R<T>	ok()
static <T> R<T>	OK()
static <T> R<T>	ok(T data)
static <T> R<T>	ok(T data, CodeEnum code)
static <T> R<T>	ok(T data, I18nAware code)
static <T> R<T>	ok(T data, String code)
static <T> R<T>	ok(T data, String code, I18nAware message)
static <T> R<T>	ok(T data, String code, String message)
static <T> R<T>	okCode(CodeEnum code)
static <T> R<T>	okCode(String code)
static <T> R<T>	okCodeMessage(CodeEnum code)
static <T> R<T>	okMessage(I18nAware message)
static <T> R<T>	okMessage(String message)
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>	orCodeMessage(boolean success, CodeEnum okCode, CodeEnum 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(String code)
R<T>	setCodeIfNg(String code)
R<T>	setCodeIfNg(@NotNull Supplier<String> code)
R<T>	setCodeIfOk(String code)
R<T>	setCodeIfOk(@NotNull Supplier<String> code)
R<T>	setCodeMessage(CodeEnum code)
R<T>	setCodeMessage(String code, String message)
R<T>	setCodeMessageIfNg(CodeEnum code)
R<T>	setCodeMessageIfNg(@NotNull Supplier<CodeEnum> code)
R<T>	setCodeMessageIfOk(CodeEnum code)
R<T>	setCodeMessageIfOk(@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>	setErrors(List<I18nNotice> errors)
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 pro.fessional.mirana.i18n.I18nMessage

getI18nArgs, getI18nCode, getI18nHint, getMessage, of, setI18nArgs, setI18nCode, setMessage, setMessageBy, setMessageBy, setMessageBy, setMessageBy

Methods inherited from class java.lang.Object

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

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

getDataIf, getDataOr

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

getErrorsIf, getErrorsOr

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

getCodeIf, getCodeOr

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

getI18nArgs, getI18nArgsIf, getI18nArgsOr, getI18nCode, getI18nCodeIf, getI18nCodeOr, getI18nHint, getI18nHintIf, getI18nHintOr, toI18nString, toI18nString, toI18nString, toString, toString, toString

Methods inherited from interface pro.fessional.mirana.cast.ChainingCast

cast

Field Detail

success

protected boolean success

data

protected Object data

code

protected String code

errors

protected List<I18nNotice> errors

cause

protected Object cause

Constructor Detail

R

public R()

R

public R(boolean success)

R

public R(boolean success,
         T data)

R

public R(boolean success,
         T data,
         String code)

R

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

R

public R(boolean success,
         T data,
         String code,
         String message,
         String i18nCode)

R

public R(boolean success,
         T data,
         String code,
         String message,
         String i18nCode,
         Object... i18nArgs)

R

public R(boolean success,
         T data,
         String code,
         I18nAware message)

R

public R(boolean success,
         T data,
         I18nAware message)

R

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

R

public R(I18nNotice err)

R

public R(List<I18nNotice> errs)

Method Detail

isSuccess

public boolean isSuccess()

Description copied from interface: DoneAware

whether success, default false.

Specified by:

isSuccess in interface DoneAware

setSuccess

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

getData

public T getData()

Description copied from interface: DataAware

the biz-data to caller

Specified by:

getData in interface DataAware<T>

setData

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

getCode

public String getCode()

Specified by:

getCode in interface CodeAware

setCode

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

getErrors

@Nullable
public @Nullable List<I18nNotice> getErrors()

Description copied from interface: ErrorResult

errors cause success to be false, should be null if empty.

Specified by:

getErrors in interface ErrorResult

setErrors

@Contract(value="_->this")
public R<T> setErrors(List<I18nNotice> errors)

applyLocale

public void applyLocale(Locale locale,
                        @NotNull
                        @NotNull I18nAware.I18nSource source)

Description copied from interface: I18nAware

apply the internal locale and updates the i18n state based on the provided source.

Specified by:

applyLocale in interface I18nAware

Overrides:

applyLocale in class I18nMessage

Parameters:

locale - the locale to be applied

source - the i18n source providing the translations

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)

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)

setCodeIfOk

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

setCodeIfNg

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

setCodeIfOk

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

setCodeIfNg

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

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)

setCodeMessage

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

setCodeMessage

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

setCodeMessageIfOk

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

setCodeMessageIfNg

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

setCodeMessageIfOk

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

setCodeMessageIfNg

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

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

equals

public boolean equals(Object o)

Overrides:

equals in class I18nMessage

hashCode

public int hashCode()

Overrides:

hashCode in class I18nMessage

toString

public String toString()

Overrides:

toString in class I18nMessage

orData

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

orCode

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

orCode

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

orMessage

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

orCodeMessage

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

of

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

of

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

of

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

of

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

of

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

of

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

of

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

ofCode

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

ofCode

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

ofMessage

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

ofMessage

public static <T> R<T> ofMessage(boolean success,
                                 I18nAware message)

ofCodeMessage

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

OK

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

ok

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

ok

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

ok

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

ok

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

ok

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

ok

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

ok

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

okCode

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

okCode

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

okMessage

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

okMessage

public static <T> R<T> okMessage(I18nAware message)

okCodeMessage

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

NG

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

ng

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

ng

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

ng

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

ng

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

ng

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

ng

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

ng

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

ngCode

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

ngCode

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

ngMessage

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

ngMessage

public static <T> R<T> ngMessage(I18nAware message)

ngCodeMessage

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

ngError

public static <T> R<T> ngError(I18nNotice error)

ngError

public static <T> R<T> ngError(I18nNotice error,
                               String code)

ngError

public static <T> R<T> ngError(List<I18nNotice> errors)

ngError

public static <T> R<T> ngError(List<I18nNotice> errors,
                               String code)

ngError

public static <T> R<T> ngError(Throwable t,
                               String type)

ngCause

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

ngCause

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

ngCause

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

ngCause

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

ngCause

public static <T> R<T> ngCause(Throwable t,
                               I18nAware message)

ngCause

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