com.alibaba.jvm.sandbox.api.listener.ext

类 Advice

java.lang.Object

com.alibaba.jvm.sandbox.api.listener.ext.Advice

所有已实现的接口:

Attachment

public class Advice
extends Object
implements Attachment

行为通知

从以下版本开始:

sandbox-api:1.0.10

作者:

luanjia@taobao.com

方法概要

限定符和类型	方法和说明
void	attach(Object attachment) 添加附件
void	attach(Object attachment, String mark) 添加附件并打上标记
<E> E	attachment() 获取所携带的附件
Advice	changeParameter(int index, Object changeValue) 改变方法入参
boolean	equals(Object obj)
Behavior	getBehavior() 获取触发事件的行为 一般而言能触发事件的行为是：普通方法和构造函数
int	getInvokeId()
Object[]	getParameterArray() 获取触发事件的行为入参
int	getProcessId()
Advice	getProcessTop() 获取调用顶层通知
Object	getReturnObj() 获取行为的返回结果 如果是构造函数，返回当前对象的实例 如果是普通方法，返回方法的返回值
Object	getTarget() 获取触发事件所归属的对象实例
Throwable	getThrowable() 获取行为抛出的异常
int	hashCode()
boolean	hasMark(String exceptMark) 通知是否拥有期待的标记
boolean	isProcessTop() 是否整个递进调用过程中的顶层通知
boolean	isReturn()
boolean	isThrows()
List<Advice>	listHasMarkOnChain(String exceptMark) 列出调用链路上所有拥有期待标记的调用通知
void	mark(String mark) 对通知进行标记
boolean	unMark(String mark) 删除标记

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

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

方法详细资料

isReturn

public boolean isReturn()

isThrows

public boolean isThrows()

changeParameter

public Advice changeParameter(int index,
                              Object changeValue)

改变方法入参

参数:

index - 方法入参编号(从0开始)

changeValue - 改变的值

返回:

this

getProcessId

public int getProcessId()

返回:

InvokeEvent#processId

getInvokeId

public int getInvokeId()

返回:

InvokeEvent#invokeId

getBehavior

public Behavior getBehavior()

获取触发事件的行为

一般而言能触发事件的行为是：普通方法和构造函数

返回:

触发事件的行为

getParameterArray

public Object[] getParameterArray()

获取触发事件的行为入参

返回:

触发事件的行为入参

getTarget

public Object getTarget()

获取触发事件所归属的对象实例

返回:

触发事件所归属的对象实例

getReturnObj

public Object getReturnObj()

获取行为的返回结果

• 如果是构造函数，返回当前对象的实例
• 如果是普通方法，返回方法的返回值

返回:

行为的返回结果

getThrowable

public Throwable getThrowable()

获取行为抛出的异常

返回:

行为抛出的异常

attach

public void attach(Object attachment)

从接口复制的说明: Attachment

添加附件

指定者:

attach 在接口中 Attachment

参数:

attachment - 消息附件

attachment

public <E> E attachment()

从接口复制的说明: Attachment

获取所携带的附件

指定者:

attachment 在接口中 Attachment

类型参数:

E - 附件类型(自动强制转换)，请使用者自行保障类型不会转换失败!

返回:

消息所携带的附件

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

mark

public void mark(String mark)

对通知进行标记

参数:

mark - 标记

hasMark

public boolean hasMark(String exceptMark)

通知是否拥有期待的标记

参数:

exceptMark - 期待删除的标记

返回:

TRUE:拥有;FALSE:不拥有

unMark

public boolean unMark(String mark)

删除标记

参数:

mark - 要删除的标记

返回:

TRUE:标记曾经存在，现已删；FALSE：标记从未存在，现已删；

attach

public void attach(Object attachment,
                   String mark)

添加附件并打上标记

参数:

attachment - 附件

mark - 标记

isProcessTop

public boolean isProcessTop()

是否整个递进调用过程中的顶层通知

返回:

TRUE:是;FALSE:否

getProcessTop

public Advice getProcessTop()

获取调用顶层通知

返回:

调用顶层通知

listHasMarkOnChain

public List<Advice> listHasMarkOnChain(String exceptMark)

列出调用链路上所有拥有期待标记的调用通知

参数:

exceptMark - 期待标记

返回:

调用链路上所有拥有期待标记的调用通知