net.bytebuddy.asm

Class Advice.MetaDataHandler.Default

java.lang.Object

net.bytebuddy.asm.Advice.MetaDataHandler.Default

All Implemented Interfaces:

Advice.MetaDataHandler, Advice.MetaDataHandler.ForInstrumentedMethod

Direct Known Subclasses:

Advice.MetaDataHandler.Default.WithoutStackSizeComputation, Advice.MetaDataHandler.Default.WithStackSizeComputation

Enclosing interface:

Advice.MetaDataHandler

public abstract static class Advice.MetaDataHandler.Default
extends Object
implements Advice.MetaDataHandler.ForInstrumentedMethod

A default implementation of a meta data handler for an instrumented method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Advice.MetaDataHandler.Default.ForAdvice A meta data handler that is bound to an advice method.
protected static class	Advice.MetaDataHandler.Default.TranslationMode A translation mode that determines how the fixed frames of the instrumented method are written.
protected static class	Advice.MetaDataHandler.Default.WithoutStackSizeComputation A default meta data handler that does not recompute the space requirements of an instrumented method.
protected static class	Advice.MetaDataHandler.Default.WithStackSizeComputation A default meta data handler that recomputes the space requirements of an instrumented method.

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

Advice.MetaDataHandler.Default, Advice.MetaDataHandler.ForInstrumentedMethod, Advice.MetaDataHandler.NoOp

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodDescription.InDefinedShape	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.

Fields inherited from interface net.bytebuddy.asm.Advice.MetaDataHandler.ForInstrumentedMethod

UNDEFINED_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract Advice.MetaDataHandler.Default.ForAdvice	bind(MethodDescription.InDefinedShape adviceMethod, TypeList requiredTypes, TypeList yieldedTypes, Advice.MetaDataHandler.Default.TranslationMode translationMode) Binds the given advice method to an appropriate meta data handler.
Advice.MetaDataHandler.Default.ForAdvice	bindEntry(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the entry advice.
Advice.MetaDataHandler.Default.ForAdvice	bindExit(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the exit advice.
int	getReaderHint() Returns the reader hint to apply when parsing the advice method.
void	injectCompletionFrame(MethodVisitor methodVisitor, boolean secondary) Injects a frame after a method's completion.
protected void	injectFullFrame(MethodVisitor methodVisitor, List<? extends TypeDescription> additionalTypes, boolean exceptionOnStack) Injects a full frame.
void	injectHandlerFrame(MethodVisitor methodVisitor) Injects a frame for a method's exception handler.
protected static Advice.MetaDataHandler.ForInstrumentedMethod	of(MethodDescription.InDefinedShape instrumentedMethod, List<? extends TypeDescription> requiredTypes, List<? extends TypeDescription> yieldedTypes, int writerFlags, int readerFlags) Creates an appropriate meta data handler for an instrumented method based on the context of the method creation.
protected static Object	toFrame(TypeDescription typeDescription) Translates a type into a representation of its form inside a stack map frame.
protected void	translateFrame(MethodVisitor methodVisitor, Advice.MetaDataHandler.Default.TranslationMode translationMode, MethodDescription.InDefinedShape 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, toString, wait, wait, wait

Methods inherited from interface net.bytebuddy.asm.Advice.MetaDataHandler.ForInstrumentedMethod

compoundLocalVariableLength, compoundStackSize

Field Detail

instrumentedMethod

protected final MethodDescription.InDefinedShape 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(MethodDescription.InDefinedShape instrumentedMethod,
                  TypeList requiredTypes,
                  TypeList yieldedTypes,
                  boolean expandFrames)

Creates a new default meta data handler.

Parameters:

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.MetaDataHandler.ForInstrumentedMethod of(MethodDescription.InDefinedShape instrumentedMethod,
                                                                 List<? extends TypeDescription> requiredTypes,
                                                                 List<? extends TypeDescription> yieldedTypes,
                                                                 int writerFlags,
                                                                 int readerFlags)

Creates an appropriate meta data handler for an instrumented method based on the context of the method creation.

Parameters:

instrumentedMethod - The instrumented method.

requiredTypes - The additional types that are added by the entry advice.

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

writerFlags - The ASM flags supplied to the ClassWriter.

readerFlags - The ASM flags supplied to the ClassReader.

Returns:

An appropriate meta data handler.

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.MetaDataHandler.Default.ForAdvice bindEntry(MethodDescription.InDefinedShape adviceMethod)

Description copied from interface: Advice.MetaDataHandler.ForInstrumentedMethod

Binds this meta data handler for the entry advice.

Specified by:

bindEntry in interface Advice.MetaDataHandler.ForInstrumentedMethod

Parameters:

adviceMethod - The entry advice method.

Returns:

An appropriate meta data handler for the enter method.

bindExit

public Advice.MetaDataHandler.Default.ForAdvice bindExit(MethodDescription.InDefinedShape adviceMethod)

Description copied from interface: Advice.MetaDataHandler.ForInstrumentedMethod

Binds this meta data handler for the exit advice.

Specified by:

bindExit in interface Advice.MetaDataHandler.ForInstrumentedMethod

Parameters:

adviceMethod - The exit advice method.

Returns:

An appropriate meta data handler for the enter method.

bind

protected abstract Advice.MetaDataHandler.Default.ForAdvice bind(MethodDescription.InDefinedShape adviceMethod,
                                                                 TypeList requiredTypes,
                                                                 TypeList yieldedTypes,
                                                                 Advice.MetaDataHandler.Default.TranslationMode translationMode)

Binds the given advice method to an appropriate meta data handler.

Parameters:

adviceMethod - The advice method.

requiredTypes - The expected types that the advice method requires additionally to the instrumented method's parameters.

yieldedTypes - The types this advice method yields as additional parameters.

translationMode - The translation mode to apply for this advice.

Returns:

An appropriate meta data handler.

getReaderHint

public int getReaderHint()

Description copied from interface: Advice.MetaDataHandler.ForInstrumentedMethod

Returns the reader hint to apply when parsing the advice method.

Specified by:

getReaderHint in interface Advice.MetaDataHandler.ForInstrumentedMethod

Returns:

The reader hint for parsing the advice method.

translateFrame

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

Description copied from interface: Advice.MetaDataHandler

Translates a frame.

Specified by:

translateFrame in interface Advice.MetaDataHandler

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.MetaDataHandler.Default.TranslationMode translationMode,
                              MethodDescription.InDefinedShape 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.

injectHandlerFrame

public void injectHandlerFrame(MethodVisitor methodVisitor)

Description copied from interface: Advice.MetaDataHandler

Injects a frame for a method's exception handler.

Specified by:

injectHandlerFrame in interface Advice.MetaDataHandler

Parameters:

methodVisitor - The method visitor to write the frame to.

injectCompletionFrame

public void injectCompletionFrame(MethodVisitor methodVisitor,
                                  boolean secondary)

Description copied from interface: Advice.MetaDataHandler

Injects a frame after a method's completion.

Specified by:

injectCompletionFrame in interface Advice.MetaDataHandler

Parameters:

methodVisitor - The method visitor to write the frame to.

secondary - true if the frame is written a second time.

injectFullFrame

protected void injectFullFrame(MethodVisitor methodVisitor,
                               List<? extends TypeDescription> additionalTypes,
                               boolean exceptionOnStack)

Injects a full frame.

Parameters:

methodVisitor - The method visitor for which the frame should be written.

additionalTypes - The additional types that are considered to be part of the method's parameters.

exceptionOnStack - true if there is a Throwable on the operand stack.