public interface ClassHandler
This interface is used by Robolectric when instrumented classes are created and interacted with.
| Modifier and Type | Interface and Description |
|---|---|
static interface |
ClassHandler.Plan
An execution plan, which can be invoked to satisfy a requested method call.
|
| Modifier and Type | Method and Description |
|---|---|
void |
classInitializing(java.lang.Class clazz)
Called by Robolectric when an instrumented class is first loaded into a sandbox and is ready to be statically initialized.
|
java.lang.invoke.MethodHandle |
findShadowMethodHandle(java.lang.Class<?> theClass,
java.lang.String name,
java.lang.invoke.MethodType methodType,
boolean isStatic)
Called by Robolectric when an instrumented method is invoked.
|
java.lang.invoke.MethodHandle |
getShadowCreator(java.lang.Class<?> theClass)
Called by Robolectric to determine how to create and initialize a shadow object when a new instance of an instrumented class has been instantiated.
|
java.lang.Object |
initializing(java.lang.Object instance)
Called by Robolectric when a new instance of an instrumented class has been created and is ready to be initialized (but only on JVMs which don’t support the
invokedynamic instruction). |
java.lang.Object |
intercept(java.lang.String signature,
java.lang.Object instance,
java.lang.Object[] params,
java.lang.Class<?> theClass)
Called by Robolectric when an intercepted method is invoked.
|
ClassHandler.Plan |
methodInvoked(java.lang.String signature,
boolean isStatic,
java.lang.Class<?> theClass)
Called by Robolectric when an instrumented method is invoked.
|
<T extends java.lang.Throwable> |
stripStackTrace(T throwable)
Removes Robolectric noise from stack traces.
|
void classInitializing(java.lang.Class clazz)
Called by Robolectric when an instrumented class is first loaded into a sandbox and is ready to be statically initialized.
This happens in place of any static initialization that may be performed by the class being loaded. The class will have a method named __staticInitializer__ which may be invoked to perform its normal initialization from <clinit>.
clazz - the class being loadedjava.lang.Object initializing(java.lang.Object instance)
Called by Robolectric when a new instance of an instrumented class has been created and is ready to be initialized (but only on JVMs which don’t support the invokedynamic instruction).
This happens before constructor code executes on the new instance.
Implementations may return an object which will be associated with the new instance and passed along on future calls to methodInvoked(String, boolean, Class).
instance - the newly-created instancefor newer JVMsClassHandler.Plan methodInvoked(java.lang.String signature, boolean isStatic, java.lang.Class<?> theClass)
Called by Robolectric when an instrumented method is invoked.
Implementations should return an ClassHandler.Plan, which will be invoked with details about the current instance and parameters.
Implementations may also return null, in which case the method’s original code will be executed.
signature - the JVM internal-format signature of the method being invoked (e.g. android/view/View/measure(II)V)isStatic - true if the method is statictheClass - the class on which the method is declarednull if the original method’s code should be executedfor newer JVMsjava.lang.invoke.MethodHandle getShadowCreator(java.lang.Class<?> theClass)
Called by Robolectric to determine how to create and initialize a shadow object when a new instance of an instrumented class has been instantiated. (but only on JVMs which support the invokedynamic instruction).
The returned MethodHandle will be invoked after the new object has been allocated but before its constructor code is executed.
Note that this is not directly analogous to initializing(Object); the return value from this method will be cached and used again for other instantiations of instances of the same class.
theClass - the instrumented classfor older JVMs,
for invalidating the returned {@link MethodHandle}java.lang.invoke.MethodHandle findShadowMethodHandle(java.lang.Class<?> theClass,
java.lang.String name,
java.lang.invoke.MethodType methodType,
boolean isStatic)
throws java.lang.IllegalAccessException
Called by Robolectric when an instrumented method is invoked.
Implementations should return an MethodHandle, which will be invoked with details about the current instance and parameters.
Implementations may also return null, in which case the method’s original code will be executed.
theClass - the class on which the method is declaredname - the name of the methodmethodType - the method typeisStatic - true if the method is staticnull if the original method’s code should be executedjava.lang.IllegalAccessExceptionfor older JVMs,
for invalidating the returned {@link MethodHandle}java.lang.Object intercept(java.lang.String signature,
java.lang.Object instance,
java.lang.Object[] params,
java.lang.Class<?> theClass)
throws java.lang.Throwable
Called by Robolectric when an intercepted method is invoked.
Unlike instrumented methods, calls to intercepted methods are modified in place by Robolectric in the calling code. This is useful when the method about to be invoked doesn’t exist in the current JVM (e.g. because of Android differences).
signature - the JVM internal-format signature of the method being invoked (e.g. android/view/View/measure(II)V)instance - the instance on which the method would have been invokedparams - the parameters to the methodtheClass - the class on which the method is declaredjava.lang.Throwable - if anything bad happens<T extends java.lang.Throwable> T stripStackTrace(T throwable)
Removes Robolectric noise from stack traces.
T - the type of exceptionthrowable - the exception to be stripped