org.robolectric.internal.bytecode

Class ShadowWrangler

java.lang.Object

org.robolectric.internal.bytecode.ShadowWrangler

All Implemented Interfaces:

ClassHandler

public class ShadowWrangler
extends java.lang.Object
implements ClassHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.robolectric.internal.bytecode.ClassHandler

ClassHandler.Plan

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.reflect.Method	CALL_REAL_CODE
static ClassHandler.Plan	CALL_REAL_CODE_PLAN
static java.lang.invoke.MethodHandle	DO_NOTHING
static Function<java.lang.Object,java.lang.Object>	DO_NOTHING_HANDLER
static java.lang.reflect.Method	DO_NOTHING_METHOD
static ClassHandler.Plan	DO_NOTHING_PLAN
static Implementation	IMPLEMENTATION_DEFAULTS

Constructor Summary

Constructors

Constructor and Description
ShadowWrangler(ShadowMap shadowMap, int apiLevel, Interceptors interceptors)

Method Summary

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<?> definingClass, 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.
static java.lang.Class<?>	loadClass(java.lang.String paramType, java.lang.ClassLoader classLoader)
ClassHandler.Plan	methodInvoked(java.lang.String signature, boolean isStatic, java.lang.Class<?> theClass) Called by Robolectric when an instrumented method is invoked.
protected java.lang.reflect.Method	pickShadowMethod(java.lang.Class<?> definingClass, java.lang.String name, java.lang.Class<?>[] paramTypes)
<T extends java.lang.Throwable> T	stripStackTrace(T throwable) Removes Robolectric noise from stack traces.

Methods inherited from class java.lang.Object

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

Field Detail

DO_NOTHING_HANDLER

public static final Function<java.lang.Object,java.lang.Object> DO_NOTHING_HANDLER

DO_NOTHING_PLAN

public static final ClassHandler.Plan DO_NOTHING_PLAN

CALL_REAL_CODE_PLAN

public static final ClassHandler.Plan CALL_REAL_CODE_PLAN

CALL_REAL_CODE

public static final java.lang.reflect.Method CALL_REAL_CODE

DO_NOTHING

public static final java.lang.invoke.MethodHandle DO_NOTHING

DO_NOTHING_METHOD

public static final java.lang.reflect.Method DO_NOTHING_METHOD

IMPLEMENTATION_DEFAULTS

public static final Implementation IMPLEMENTATION_DEFAULTS

Constructor Detail

ShadowWrangler

public ShadowWrangler(ShadowMap shadowMap,
                      int apiLevel,
                      Interceptors interceptors)

Method Detail

loadClass

public static java.lang.Class<?> loadClass(java.lang.String paramType,
                                           java.lang.ClassLoader classLoader)

classInitializing

public void classInitializing(java.lang.Class clazz)

Description copied from interface: ClassHandler

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>.

Specified by:

classInitializing in interface ClassHandler

Parameters:

clazz - the class being loaded

initializing

public java.lang.Object initializing(java.lang.Object instance)

Description copied from interface: ClassHandler

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 ClassHandler.methodInvoked(String, boolean, Class).

Specified by:

initializing in interface ClassHandler

Parameters:

instance - the newly-created instance

Returns:

a data value to be associated with the new instance

See Also:

for newer JVMs

methodInvoked

public ClassHandler.Plan methodInvoked(java.lang.String signature,
                                       boolean isStatic,
                                       java.lang.Class<?> theClass)

Description copied from interface: ClassHandler

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.

Specified by:

methodInvoked in interface ClassHandler

Parameters:

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 static

theClass - the class on which the method is declared

Returns:

an execution plan, or null if the original method’s code should be executed

See Also:

for newer JVMs

findShadowMethodHandle

public java.lang.invoke.MethodHandle findShadowMethodHandle(java.lang.Class<?> definingClass,
                                                            java.lang.String name,
                                                            java.lang.invoke.MethodType methodType,
                                                            boolean isStatic)
                                                     throws java.lang.IllegalAccessException

Description copied from interface: ClassHandler

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.

Specified by:

findShadowMethodHandle in interface ClassHandler

Parameters:

definingClass - the class on which the method is declared

name - the name of the method

methodType - the method type

isStatic - true if the method is static

Returns:

a method handle to invoke, or null if the original method’s code should be executed

Throws:

java.lang.IllegalAccessException

See Also:

for older JVMs, for invalidating the returned {@link MethodHandle}

pickShadowMethod

protected java.lang.reflect.Method pickShadowMethod(java.lang.Class<?> definingClass,
                                                    java.lang.String name,
                                                    java.lang.Class<?>[] paramTypes)

intercept

public java.lang.Object intercept(java.lang.String signature,
                                  java.lang.Object instance,
                                  java.lang.Object[] params,
                                  java.lang.Class theClass)
                           throws java.lang.Throwable

Description copied from interface: ClassHandler

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).

Specified by:

intercept in interface ClassHandler

Parameters:

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 invoked

params - the parameters to the method

theClass - the class on which the method is declared

Returns:

the value to be returned

Throws:

java.lang.Throwable - if anything bad happens

stripStackTrace

public <T extends java.lang.Throwable> T stripStackTrace(T throwable)

Description copied from interface: ClassHandler

Removes Robolectric noise from stack traces.

Specified by:

stripStackTrace in interface ClassHandler

Type Parameters:

T - the type of exception

Parameters:

throwable - the exception to be stripped

Returns:

the stripped stack trace

getShadowCreator

public java.lang.invoke.MethodHandle getShadowCreator(java.lang.Class<?> theClass)

Description copied from interface: ClassHandler

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 ClassHandler.initializing(Object); the return value from this method will be cached and used again for other instantiations of instances of the same class.

Specified by:

getShadowCreator in interface ClassHandler

Parameters:

theClass - the instrumented class

Returns:

a data value to be associated with the new instance

See Also:

for older JVMs, for invalidating the returned {@link MethodHandle}