net.bytebuddy.asm

Class Advice.AdviceVisitor

java.lang.Object

org.objectweb.asm.MethodVisitor

net.bytebuddy.utility.ExceptionTableSensitiveMethodVisitor

net.bytebuddy.asm.Advice.AdviceVisitor

Direct Known Subclasses:

Advice.AdviceVisitor.WithExitAdvice, Advice.AdviceVisitor.WithoutExitAdvice

Enclosing class:

Advice

protected abstract static class Advice.AdviceVisitor
extends ExceptionTableSensitiveMethodVisitor

A method visitor that weaves the advice methods' byte codes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Advice.AdviceVisitor.WithExitAdvice An advice visitor that applies exit advice.
protected static class	Advice.AdviceVisitor.WithoutExitAdvice An advice visitor that does not apply exit advice.

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodDescription.InDefinedShape	instrumentedMethod A description of the instrumented method.
protected Advice.Dispatcher.Bound	methodExit The dispatcher to be used for method exit.
protected Advice.MethodSizeHandler	methodSizeHandler A handler for computing the method size requirements.
protected Advice.StackMapFrameHandler.ForInstrumentedMethod	stackMapFrameHandler A handler for translating and injecting stack map frames.

Fields inherited from class org.objectweb.asm.MethodVisitor

api, mv

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdviceVisitor(MethodVisitor methodVisitor, MethodDescription.InDefinedShape instrumentedMethod, Advice.Dispatcher.Resolved.ForMethodEnter methodEnter, Advice.Dispatcher.Resolved.ForMethodExit methodExit, List<? extends TypeDescription> yieldedTypes, ClassFileVersion classFileVersion, int writerFlags, int readerFlags) Creates a new advice visitor.

Method Summary

Modifier and Type	Method and Description
protected void	onAfterExceptionTable() Invoked after the exception table was visited.
protected abstract void	onUserEnd() Writes the advice for completing the instrumented method.
protected abstract void	onUserPrepare() Invoked when the user method's exception handler (if any) is supposed to be prepared.
protected abstract void	onUserStart() Writes the advice for entering the instrumented method.
protected void	onVisitIincInsn(int offset, int increment) Visits an increment instruction.
protected void	onVisitVarInsn(int opcode, int offset) Visits an variable instruction.
protected void	variable(int opcode) Access the first variable after the instrumented variables and return type are stored.
protected void	variable(int opcode, int offset) Access the first variable after the instrumented variables and return type are stored.
void	visitFrame(int frameType, int localVariableLength, Object[] localVariable, int stackSize, Object[] stack)
void	visitMaxs(int stackSize, int localVariableLength)

Methods inherited from class net.bytebuddy.utility.ExceptionTableSensitiveMethodVisitor

onVisitFieldInsn, onVisitInsn, onVisitIntInsn, onVisitInvokeDynamicInsn, onVisitJumpInsn, onVisitLabel, onVisitLdcInsn, onVisitLookupSwitchInsn, onVisitMethodInsn, onVisitMethodInsn, onVisitMultiANewArrayInsn, onVisitTableSwitchInsn, onVisitTypeInsn, visitFieldInsn, visitIincInsn, visitInsn, visitIntInsn, visitInvokeDynamicInsn, visitJumpInsn, visitLabel, visitLdcInsn, visitLookupSwitchInsn, visitMethodInsn, visitMethodInsn, visitMultiANewArrayInsn, visitTableSwitchInsn, visitTypeInsn, visitVarInsn

Methods inherited from class org.objectweb.asm.MethodVisitor

visitAnnotation, visitAnnotationDefault, visitAttribute, visitCode, visitEnd, visitInsnAnnotation, visitLineNumber, visitLocalVariable, visitLocalVariableAnnotation, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTryCatchBlock, visitTypeAnnotation

Methods inherited from class java.lang.Object

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

Field Detail

instrumentedMethod

protected final MethodDescription.InDefinedShape instrumentedMethod

A description of the instrumented method.

methodExit

protected final Advice.Dispatcher.Bound methodExit

The dispatcher to be used for method exit.

methodSizeHandler

protected final Advice.MethodSizeHandler methodSizeHandler

A handler for computing the method size requirements.

stackMapFrameHandler

protected final Advice.StackMapFrameHandler.ForInstrumentedMethod stackMapFrameHandler

A handler for translating and injecting stack map frames.

Constructor Detail

AdviceVisitor

protected AdviceVisitor(MethodVisitor methodVisitor,
                        MethodDescription.InDefinedShape instrumentedMethod,
                        Advice.Dispatcher.Resolved.ForMethodEnter methodEnter,
                        Advice.Dispatcher.Resolved.ForMethodExit methodExit,
                        List<? extends TypeDescription> yieldedTypes,
                        ClassFileVersion classFileVersion,
                        int writerFlags,
                        int readerFlags)

Creates a new advice visitor.

Parameters:

methodVisitor - The method visitor to which all instructions are written.

instrumentedMethod - The instrumented method.

methodEnter - The method enter advice.

methodExit - The method exit advice.

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

classFileVersion - The instrumented type's class file version.

writerFlags - The ASM writer flags that were set.

readerFlags - The ASM reader flags that were set.

Method Detail

onAfterExceptionTable

protected void onAfterExceptionTable()

Description copied from class: ExceptionTableSensitiveMethodVisitor

Invoked after the exception table was visited. Typically, the exception table is visited by ASM at the beginning of a method. It is however possible that a user adds exception table entries at a later point. Normally, this is however not meaningful use of ASM.

Specified by:

onAfterExceptionTable in class ExceptionTableSensitiveMethodVisitor

onUserPrepare

protected abstract void onUserPrepare()

Invoked when the user method's exception handler (if any) is supposed to be prepared.

onUserStart

protected abstract void onUserStart()

Writes the advice for entering the instrumented method.

onVisitVarInsn

protected void onVisitVarInsn(int opcode,
                              int offset)

Description copied from class: ExceptionTableSensitiveMethodVisitor

Visits an variable instruction.

Overrides:

onVisitVarInsn in class ExceptionTableSensitiveMethodVisitor

Parameters:

opcode - The visited opcode.

offset - The visited offset.

onVisitIincInsn

protected void onVisitIincInsn(int offset,
                               int increment)

Description copied from class: ExceptionTableSensitiveMethodVisitor

Visits an increment instruction.

Overrides:

onVisitIincInsn in class ExceptionTableSensitiveMethodVisitor

Parameters:

offset - The offset of the accessed variable.

increment - The value with which to increment.

variable

protected void variable(int opcode)

Access the first variable after the instrumented variables and return type are stored.

Parameters:

opcode - The opcode for accessing the variable.

variable

protected void variable(int opcode,
                        int offset)

Access the first variable after the instrumented variables and return type are stored.

Parameters:

opcode - The opcode for accessing the variable.

offset - The additional offset of the variable.

visitFrame

public void visitFrame(int frameType,
                       int localVariableLength,
                       Object[] localVariable,
                       int stackSize,
                       Object[] stack)

Overrides:

visitFrame in class MethodVisitor

visitMaxs

public void visitMaxs(int stackSize,
                      int localVariableLength)

Overrides:

visitMaxs in class MethodVisitor

onUserEnd

protected abstract void onUserEnd()

Writes the advice for completing the instrumented method.