net.bytebuddy.instrumentation.method.bytecode.stack.member

Enum MethodVariableAccess

java.lang.Object

java.lang.Enum<MethodVariableAccess>

net.bytebuddy.instrumentation.method.bytecode.stack.member.MethodVariableAccess

All Implemented Interfaces:

Serializable, Comparable<MethodVariableAccess>

public enum MethodVariableAccess
extends Enum<MethodVariableAccess>

A stack assignment that loads a method variable from a given index of the local variable array.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MethodVariableAccess.ArgumentLoadingStackManipulation A stack manipulation for loading a variable of a method's local variable array onto the operand stack.
protected static interface	MethodVariableAccess.TypeCastingHandler A handler for optionally applying a type casting for each method parameter that is loaded onto the operand stack.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOUBLE The accessor handler for a double.
FLOAT The accessor handler for a float.
INTEGER The accessor handler for a JVM-integer.
LONG The accessor handler for a long.
REFERENCE The accessor handler for a reference type.

Method Summary

Modifier and Type	Method and Description
static StackManipulation	forBridgeMethodInvocation(MethodDescription bridgeMethod, MethodDescription targetMethod) Creates a stack manipulation for loading all parameters of a Java bridge method onto the operand stack where all variables of the bridge method are casted to the parameter types of the target method.
static MethodVariableAccess	forType(TypeDescription typeDescription) Locates the correct accessor for a variable of a given type.
static StackManipulation	loadArguments(MethodDescription methodDescription) Loads all method arguments for a given method onto the operand stack.
StackManipulation	loadFromIndex(int variableOffset) Creates a stack assignment for a given index of the local variable array.
static StackManipulation	loadThisReferenceAndArguments(MethodDescription methodDescription) Loads all method arguments for a given method onto the operand stack, including a reference to this, if the method is non-static.
static MethodVariableAccess	valueOf(String name) Returns the enum constant of this type with the specified name.
static MethodVariableAccess[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTEGER

public static final MethodVariableAccess INTEGER

The accessor handler for a JVM-integer.

LONG

public static final MethodVariableAccess LONG

The accessor handler for a long.

FLOAT

public static final MethodVariableAccess FLOAT

The accessor handler for a float.

DOUBLE

public static final MethodVariableAccess DOUBLE

The accessor handler for a double.

REFERENCE

public static final MethodVariableAccess REFERENCE

The accessor handler for a reference type.

Method Detail

values

public static MethodVariableAccess[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MethodVariableAccess c : MethodVariableAccess.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MethodVariableAccess valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forType

public static MethodVariableAccess forType(TypeDescription typeDescription)

Locates the correct accessor for a variable of a given type.

Parameters:

typeDescription - The type of the variable to be loaded.

Returns:

An accessor for the given type.

loadThisReferenceAndArguments

public static StackManipulation loadThisReferenceAndArguments(MethodDescription methodDescription)

Loads all method arguments for a given method onto the operand stack, including a reference to this, if the method is non-static.

Parameters:

methodDescription - The method for which all method arguments should be loaded onto the stack, including a reference to this if the method is non-static.

Returns:

A stack manipulation representing the loading of all method arguments including a reference to the instance if any.

loadArguments

public static StackManipulation loadArguments(MethodDescription methodDescription)

Loads all method arguments for a given method onto the operand stack.

Parameters:

methodDescription - The method for which all method arguments should be loaded onto the stack.

Returns:

A stack manipulation representing the loading of all method arguments.

forBridgeMethodInvocation

public static StackManipulation forBridgeMethodInvocation(MethodDescription bridgeMethod,
                                                          MethodDescription targetMethod)

Creates a stack manipulation for loading all parameters of a Java bridge method onto the operand stack where all variables of the bridge method are casted to the parameter types of the target method. For legally applying this manipulation, the bridge method's parameters must all be super types of the target method. The resulting stack manipulation does not load the this reference onto the operand stack.

Parameters:

bridgeMethod - The bridge method that is invoking its target method.

targetMethod - The target of the bridge method.

Returns:

A stack manipulation that loads all parameters of the bridge method onto the stack while type casting the parameters to the value of its target method.

loadFromIndex

public StackManipulation loadFromIndex(int variableOffset)

Creates a stack assignment for a given index of the local variable array.

The index has to be relative to the method's local variable array size.

Parameters:

variableOffset - The offset of the variable where double and long types count two slots.

Returns:

A stack manipulation representing the method retrieval.