RpcWrapper (orion-kit 2.0.1 API)

java.lang.Object
- cn.orionsec.kit.lang.define.support.CloneSupport<RpcWrapper<T>>
- - cn.orionsec.kit.lang.define.wrapper.RpcWrapper<T>

All Implemented Interfaces:

IJsonObject, ILogObject, IMapObject<String,Object>, Wrapper<T>, Serializable, Cloneable
```
public class RpcWrapper<T>
extends CloneSupport<RpcWrapper<T>>
implements Wrapper<T>, ILogObject, IMapObject<String,Object>
```
rpc 远程调用结果封装

Since:

2019/5/29 11:27

Version:

1.0.0

Author:

Jiahang Li

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PRC_TRACE_PREFIX`
`static Integer`	`RPC_ERROR_CODE`
`static String`	`RPC_ERROR_MESSAGE`
`static Integer`	`RPC_SUCCESS_CODE`
`static String`	`RPC_SUCCESS_MESSAGE`

Constructor Summary

Constructors
Constructor and Description
`RpcWrapper()`
`RpcWrapper(CodeInfo info)`
`RpcWrapper(CodeInfo info, T data)`
`RpcWrapper(int code)`
`RpcWrapper(int code, String msg)`
`RpcWrapper(int code, String msg, T data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RpcWrapper<T>`	`addErrorMessage(String errorMsg)`
`void`	`checkIsError()` 失败抛出异常
`void`	`checkIsError(Supplier<? extends RuntimeException> e)`
`RpcWrapper<T>`	`code(int code)`
`RpcWrapper<T>`	`data(T data)`
`static <T> RpcWrapper<T>`	`error()` 失败
`static <T> RpcWrapper<T>`	`error(String msg)`
`static <T> RpcWrapper<T>`	`error(String msg, Object... params)`
`static <T> RpcWrapper<T>`	`error(Throwable t)`
`static <T> RpcWrapper<T>`	`get()` 初始化
`int`	`getCode()`
`T`	`getData()`
`List<String>`	`getErrorMessages()`
`String`	`getErrorMessageString()`
`String`	`getMsg()`
`String`	`getTraceId()`
`boolean`	`isSuccess()` 检查是否成功
`<E> RpcWrapper<E>`	`map(Function<T,E> mapping)` 映射
`RpcWrapper<T>`	`msg(String msg)`
`static <T> RpcWrapper<T>`	`of(CodeInfo info)` 定义
`static <T> RpcWrapper<T>`	`of(CodeInfo info, T data)`
`static <T> RpcWrapper<T>`	`of(int code)`
`static <T> RpcWrapper<T>`	`of(int code, String msg)`
`static <T> RpcWrapper<T>`	`of(int code, String msg, T data)`
`Optional<T>`	`optional()`
`void`	`setCode(int code)`
`void`	`setData(T data)`
`void`	`setErrorMessages(List<String> errorMessages)`
`void`	`setMsg(String msg)`
`void`	`setTraceId(String traceId)`
`static <T> RpcWrapper<T>`	`success()` 成功
`static <T> RpcWrapper<T>`	`success(T data)`
`HttpWrapper<T>`	`toHttpWrapper()`
`String`	`toLogString()` 转为日志
`Map<String,Object>`	`toMap()` 转为 map
`String`	`toString()`
`RpcWrapper<T>`	`trace(Object object)`

Methods inherited from class cn.orionsec.kit.lang.define.support.CloneSupport
clone

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cn.orionsec.kit.lang.able.IJsonObject
toJsonString

Methods inherited from interface cn.orionsec.kit.lang.able.IMapObject
asMap

Field Detail

RPC_SUCCESS_CODE

public static final Integer RPC_SUCCESS_CODE

RPC_SUCCESS_MESSAGE

public static final String RPC_SUCCESS_MESSAGE

RPC_ERROR_CODE

public static final Integer RPC_ERROR_CODE

RPC_ERROR_MESSAGE

public static final String RPC_ERROR_MESSAGE

PRC_TRACE_PREFIX

public static final String PRC_TRACE_PREFIX

Constructor Detail

RpcWrapper
```
public RpcWrapper()
```

RpcWrapper
```
public RpcWrapper(int code)
```

RpcWrapper

public RpcWrapper(int code,
                  String msg)

RpcWrapper

public RpcWrapper(int code,
                  String msg,
                  T data)

RpcWrapper
```
public RpcWrapper(CodeInfo info)
```

RpcWrapper

public RpcWrapper(CodeInfo info,
                  T data)

Method Detail

get

public static <T> RpcWrapper<T> get()

初始化

of

public static <T> RpcWrapper<T> of(CodeInfo info)

定义

of

public static <T> RpcWrapper<T> of(CodeInfo info,
                                   T data)

of

public static <T> RpcWrapper<T> of(int code)

of

public static <T> RpcWrapper<T> of(int code,
                                   String msg)

of

public static <T> RpcWrapper<T> of(int code,
                                   String msg,
                                   T data)

success

public static <T> RpcWrapper<T> success()

成功

success

public static <T> RpcWrapper<T> success(T data)

error

public static <T> RpcWrapper<T> error()

失败

error

public static <T> RpcWrapper<T> error(String msg)

error

public static <T> RpcWrapper<T> error(String msg,
                                      Object... params)

error

public static <T> RpcWrapper<T> error(Throwable t)

isSuccess
```
public boolean isSuccess()
```
检查是否成功

checkIsError
```
public void checkIsError()
```
失败抛出异常

checkIsError

public void checkIsError(Supplier<? extends RuntimeException> e)

addErrorMessage

public RpcWrapper<T> addErrorMessage(String errorMsg)

code
```
public RpcWrapper<T> code(int code)
```

msg
```
public RpcWrapper<T> msg(String msg)
```

data
```
public RpcWrapper<T> data(T data)
```

trace

public RpcWrapper<T> trace(Object object)

setCode
```
public void setCode(int code)
```

setMsg
```
public void setMsg(String msg)
```

setData
```
public void setData(T data)
```

setTraceId

public void setTraceId(String traceId)

setErrorMessages

public void setErrorMessages(List<String> errorMessages)

getCode
```
public int getCode()
```

getMsg
```
public String getMsg()
```

getData
```
public T getData()
```

getTraceId
```
public String getTraceId()
```

getErrorMessages

public List<String> getErrorMessages()

getErrorMessageString
```
public String getErrorMessageString()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

toLogString
```
public String toLogString()
```
Description copied from interface: ILogObject

转为日志

Specified by:

toLogString in interface ILogObject

Returns:

logString

toMap
```
public Map<String,Object> toMap()
```
Description copied from interface: IMapObject

转为 map

Specified by:

toMap in interface IMapObject<String,Object>

Returns:

map

toHttpWrapper
```
public HttpWrapper<T> toHttpWrapper()
```
Returns:

HttpWrapper

map
```
public <E> RpcWrapper<E> map(Function<T,E> mapping)
```
映射

Type Parameters:

E - E

Parameters:

mapping - mapping

Returns:

mapped

optional
```
public Optional<T> optional()
```
Returns:

result 的 Optional

Class RpcWrapper<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cn.orionsec.kit.lang.define.support.CloneSupport

Methods inherited from class java.lang.Object

Methods inherited from interface cn.orionsec.kit.lang.able.IJsonObject

Methods inherited from interface cn.orionsec.kit.lang.able.IMapObject

Field Detail

RPC_SUCCESS_CODE

RPC_SUCCESS_MESSAGE

RPC_ERROR_CODE

RPC_ERROR_MESSAGE

PRC_TRACE_PREFIX

Constructor Detail

RpcWrapper

RpcWrapper

RpcWrapper

RpcWrapper

RpcWrapper

RpcWrapper

Method Detail

get

of

of

of

of

of

success

success

error

error

error

error

isSuccess

checkIsError

checkIsError

addErrorMessage

code

msg

data

trace

setCode

setMsg

setData

setTraceId

setErrorMessages

getCode

getMsg

getData

getTraceId

getErrorMessages

getErrorMessageString

toString

toLogString

toMap

toHttpWrapper

map

optional