de.robv.android.xposed

Class XC_MethodReplacement

java.lang.Object

de.robv.android.xposed.callbacks.XCallback

de.robv.android.xposed.XC_MethodHook

de.robv.android.xposed.XC_MethodReplacement

public abstract class XC_MethodReplacement
extends XC_MethodHook

A special case of XC_MethodHook which completely replaces the original method.

Nested Class Summary

Nested classes/interfaces inherited from class de.robv.android.xposed.XC_MethodHook

XC_MethodHook.MethodHookParam<T extends java.lang.reflect.Executable>, XC_MethodHook.Unhook

Nested classes/interfaces inherited from class de.robv.android.xposed.callbacks.XCallback

XCallback.Param

Field Summary

Fields

Modifier and Type	Field and Description
static XC_MethodReplacement	DO_NOTHING Predefined callback that skips the method without replacements.

Fields inherited from class de.robv.android.xposed.callbacks.XCallback

priority, PRIORITY_DEFAULT, PRIORITY_HIGHEST, PRIORITY_LOWEST

Method Summary

Modifier and Type	Method and Description
protected void	afterHookedMethod(XC_MethodHook.MethodHookParam param) Called after the invocation of the method.
protected void	beforeHookedMethod(XC_MethodHook.MethodHookParam param) Called before the invocation of the method.
protected abstract java.lang.Object	replaceHookedMethod(XC_MethodHook.MethodHookParam param) Shortcut for replacing a method completely.
static XC_MethodReplacement	returnConstant(int priority, java.lang.Object result) Like returnConstant(Object), but allows to specify a priority for the callback.
static XC_MethodReplacement	returnConstant(java.lang.Object result) Creates a callback which always returns a specific value.

Methods inherited from class de.robv.android.xposed.XC_MethodHook

callAfterHookedMethod, callBeforeHookedMethod

Methods inherited from class de.robv.android.xposed.callbacks.XCallback

call, callAll

Methods inherited from class java.lang.Object

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

Field Detail

DO_NOTHING

public static final XC_MethodReplacement DO_NOTHING

Predefined callback that skips the method without replacements.

Method Detail

beforeHookedMethod

protected final void beforeHookedMethod(XC_MethodHook.MethodHookParam param)
                                 throws java.lang.Throwable

Description copied from class: XC_MethodHook

Called before the invocation of the method.

You can use XC_MethodHook.MethodHookParam.setResult(java.lang.Object) and XC_MethodHook.MethodHookParam.setThrowable(java.lang.Throwable) to prevent the original method from being called.

Note that implementations shouldn't call super(param), it's not necessary.

Overrides:

beforeHookedMethod in class XC_MethodHook

Parameters:

param - Information about the method call.

Throws:

java.lang.Throwable - Everything the callback throws is caught and logged.

afterHookedMethod

protected final void afterHookedMethod(XC_MethodHook.MethodHookParam param)
                                throws java.lang.Throwable

Description copied from class: XC_MethodHook

Called after the invocation of the method.

You can use XC_MethodHook.MethodHookParam.setResult(java.lang.Object) and XC_MethodHook.MethodHookParam.setThrowable(java.lang.Throwable) to modify the return value of the original method.

Note that implementations shouldn't call super(param), it's not necessary.

Overrides:

afterHookedMethod in class XC_MethodHook

Parameters:

param - Information about the method call.

Throws:

java.lang.Throwable - Everything the callback throws is caught and logged.

replaceHookedMethod

protected abstract java.lang.Object replaceHookedMethod(XC_MethodHook.MethodHookParam param)
                                                 throws java.lang.Throwable

Shortcut for replacing a method completely. Whatever is returned/thrown here is taken instead of the result of the original method (which will not be called).

Note that implementations shouldn't call super(param), it's not necessary.

Parameters:

param - Information about the method call.

Throws:

java.lang.Throwable - Anything that is thrown by the callback will be passed on to the original caller.

returnConstant

public static XC_MethodReplacement returnConstant(java.lang.Object result)

Creates a callback which always returns a specific value.

Parameters:

result - The value that should be returned to callers of the hooked method.

returnConstant

public static XC_MethodReplacement returnConstant(int priority,
                                                  java.lang.Object result)

Like returnConstant(Object), but allows to specify a priority for the callback.

Parameters:

priority - See XCallback.priority.

result - The value that should be returned to callers of the hooked method.