net.bytebuddy.asm

Class Advice.StackMapFrameHandler.Default

java.lang.Object

net.bytebuddy.asm.Advice.StackMapFrameHandler.Default

All Implemented Interfaces:

Advice.StackMapFrameHandler, Advice.StackMapFrameHandler.ForInstrumentedMethod

Enclosing interface:

Advice.StackMapFrameHandler

public static class Advice.StackMapFrameHandler.Default
extends Object
implements Advice.StackMapFrameHandler.ForInstrumentedMethod

A default implementation of a stack map frame handler for an instrumented method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Advice.StackMapFrameHandler.Default.ForAdvice A stack map frame handler for an advice method.
protected static class	Advice.StackMapFrameHandler.Default.TranslationMode A translation mode that determines how the fixed frames of the instrumented method are written.

Nested classes/interfaces inherited from interface net.bytebuddy.asm.Advice.StackMapFrameHandler

Advice.StackMapFrameHandler.Default, Advice.StackMapFrameHandler.ForInstrumentedMethod, Advice.StackMapFrameHandler.NoOp

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodDescription	instrumentedMethod The instrumented method.
protected TypeList	requiredTypes A list of intermediate types to be considered as part of the instrumented method's steady signature.
protected TypeList	yieldedTypes The types that are expected to be added after the instrumented method returns.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Default(TypeDescription instrumentedType, MethodDescription instrumentedMethod, TypeList requiredTypes, TypeList yieldedTypes, boolean expandFrames) Creates a new default meta data handler.

Method Summary

Modifier and Type	Method and Description
Advice.StackMapFrameHandler.ForAdvice	bindEntry(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the entry advice.
Advice.StackMapFrameHandler.ForAdvice	bindExit(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the exit advice.
int	getReaderHint() Returns a hint to supply to a ClassReader when parsing an advice method.
void	injectCompletionFrame(MethodVisitor methodVisitor, boolean secondary) Injects a frame indicating the completion of the currently handled method, i.e. all yielded types were added.
void	injectExceptionFrame(MethodVisitor methodVisitor) Injects a frame indicating the beginning of an exception handler for the currently handled method.
protected void	injectFullFrame(MethodVisitor methodVisitor, List<? extends TypeDescription> typesInArray, List<? extends TypeDescription> typesOnStack) Injects a full stack map frame.
void	injectReturnFrame(MethodVisitor methodVisitor) Injects a frame indicating the beginning of a return value handler for the currently handled method.
protected static Advice.StackMapFrameHandler.ForInstrumentedMethod	of(TypeDescription instrumentedType, MethodDescription instrumentedMethod, List<? extends TypeDescription> requiredTypes, List<? extends TypeDescription> yieldedTypes, ClassFileVersion classFileVersion, int writerFlags, int readerFlags) Creates an appropriate stack map frame handler for an instrumented method.
protected static Object	toFrame(TypeDescription typeDescription) Translates a type into a representation of its form inside a stack map frame.
String	toString()
protected void	translateFrame(MethodVisitor methodVisitor, Advice.StackMapFrameHandler.Default.TranslationMode translationMode, MethodDescription methodDescription, TypeList additionalTypes, int frameType, int localVariableLength, Object[] localVariable, int stackSize, Object[] stack) Translates a frame.
void	translateFrame(MethodVisitor methodVisitor, int type, int localVariableLength, Object[] localVariable, int stackSize, Object[] stack) Translates a frame.

Methods inherited from class java.lang.Object

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

Field Detail

instrumentedMethod

protected final MethodDescription instrumentedMethod

The instrumented method.

requiredTypes

protected final TypeList requiredTypes

A list of intermediate types to be considered as part of the instrumented method's steady signature.

yieldedTypes

protected final TypeList yieldedTypes

The types that are expected to be added after the instrumented method returns.

Constructor Detail

Default

protected Default(TypeDescription instrumentedType,
                  MethodDescription instrumentedMethod,
                  TypeList requiredTypes,
                  TypeList yieldedTypes,
                  boolean expandFrames)

Creates a new default meta data handler.

Parameters:

instrumentedType - The instrumented type.

instrumentedMethod - The instrumented method.

requiredTypes - A list of intermediate types to be considered as part of the instrumented method's steady signature.

yieldedTypes - The types that are expected to be added after the instrumented method returns.

expandFrames - true if the meta data handler is expected to expand its frames.

Method Detail

of

protected static Advice.StackMapFrameHandler.ForInstrumentedMethod of(TypeDescription instrumentedType,
                                                                      MethodDescription instrumentedMethod,
                                                                      List<? extends TypeDescription> requiredTypes,
                                                                      List<? extends TypeDescription> yieldedTypes,
                                                                      ClassFileVersion classFileVersion,
                                                                      int writerFlags,
                                                                      int readerFlags)

Creates an appropriate stack map frame handler for an instrumented method.

Parameters:

instrumentedType - The instrumented type.

instrumentedMethod - The instrumented method.

requiredTypes - A list of intermediate types to be considered as part of the instrumented method's steady signature.

yieldedTypes - The types that are expected to be added after the instrumented method returns.

classFileVersion - The instrumented type's class file version.

writerFlags - The flags supplied to the ASM writier.

readerFlags - The reader flags supplied to the ASM reader.

Returns:

An approrpiate stack map frame handler for an instrumented method.

toFrame

protected static Object toFrame(TypeDescription typeDescription)

Translates a type into a representation of its form inside a stack map frame.

Parameters:

typeDescription - The type to translate.

Returns:

A stack entry representation of the supplied type.

bindEntry

public Advice.StackMapFrameHandler.ForAdvice bindEntry(MethodDescription.InDefinedShape adviceMethod)

Description copied from interface: Advice.StackMapFrameHandler.ForInstrumentedMethod

Binds this meta data handler for the entry advice.

Specified by:

bindEntry in interface Advice.StackMapFrameHandler.ForInstrumentedMethod

Parameters:

adviceMethod - The entry advice method.

Returns:

An appropriate meta data handler for the enter method.

bindExit

public Advice.StackMapFrameHandler.ForAdvice bindExit(MethodDescription.InDefinedShape adviceMethod)

Description copied from interface: Advice.StackMapFrameHandler.ForInstrumentedMethod

Binds this meta data handler for the exit advice.

Specified by:

bindExit in interface Advice.StackMapFrameHandler.ForInstrumentedMethod

Parameters:

adviceMethod - The exit advice method.

Returns:

An appropriate meta data handler for the enter method.

getReaderHint

public int getReaderHint()

Description copied from interface: Advice.StackMapFrameHandler.ForInstrumentedMethod

Returns a hint to supply to a ClassReader when parsing an advice method.

Specified by:

getReaderHint in interface Advice.StackMapFrameHandler.ForInstrumentedMethod

Returns:

The reader hint to supply to an ASM class reader.

translateFrame

public void translateFrame(MethodVisitor methodVisitor,
                           int type,
                           int localVariableLength,
                           Object[] localVariable,
                           int stackSize,
                           Object[] stack)

Description copied from interface: Advice.StackMapFrameHandler

Translates a frame.

Specified by:

translateFrame in interface Advice.StackMapFrameHandler

Parameters:

methodVisitor - The method visitor to write the frame to.

type - The frame's type.

localVariableLength - The local variable length.

localVariable - An array containing the types of the current local variables.

stackSize - The size of the operand stack.

stack - An array containing the types of the current operand stack.

translateFrame

protected void translateFrame(MethodVisitor methodVisitor,
                              Advice.StackMapFrameHandler.Default.TranslationMode translationMode,
                              MethodDescription methodDescription,
                              TypeList additionalTypes,
                              int frameType,
                              int localVariableLength,
                              Object[] localVariable,
                              int stackSize,
                              Object[] stack)

Translates a frame.

Parameters:

methodVisitor - The method visitor to write the frame to.

translationMode - The translation mode to apply.

methodDescription - The method description for which the frame is written.

additionalTypes - The additional types to consider part of the instrumented method's parameters.

frameType - The frame's type.

localVariableLength - The local variable length.

localVariable - An array containing the types of the current local variables.

stackSize - The size of the operand stack.

stack - An array containing the types of the current operand stack.

injectReturnFrame

public void injectReturnFrame(MethodVisitor methodVisitor)

Description copied from interface: Advice.StackMapFrameHandler

Injects a frame indicating the beginning of a return value handler for the currently handled method.

Specified by:

injectReturnFrame in interface Advice.StackMapFrameHandler

Parameters:

methodVisitor - The method visitor onto which to apply the stack map frame.

injectExceptionFrame

public void injectExceptionFrame(MethodVisitor methodVisitor)

Description copied from interface: Advice.StackMapFrameHandler

Injects a frame indicating the beginning of an exception handler for the currently handled method.

Specified by:

injectExceptionFrame in interface Advice.StackMapFrameHandler

Parameters:

methodVisitor - The method visitor onto which to apply the stack map frame.

injectCompletionFrame

public void injectCompletionFrame(MethodVisitor methodVisitor,
                                  boolean secondary)

Description copied from interface: Advice.StackMapFrameHandler

Injects a frame indicating the completion of the currently handled method, i.e. all yielded types were added.

Specified by:

injectCompletionFrame in interface Advice.StackMapFrameHandler

Parameters:

methodVisitor - The method visitor onto which to apply the stack map frame.

secondary - true if another completion frame for this method was written previously.

injectFullFrame

protected void injectFullFrame(MethodVisitor methodVisitor,
                               List<? extends TypeDescription> typesInArray,
                               List<? extends TypeDescription> typesOnStack)

Injects a full stack map frame.

Parameters:

methodVisitor - The method visitor onto which to write the stack map frame.

typesInArray - The types that were added to the local variable array additionally to the values of the instrumented method.

typesOnStack - The types currently on the operand stack.

toString

public String toString()

Overrides:

toString in class Object