net.bytebuddy.asm

Enum Advice.MetaDataHandler.NoOp

java.lang.Object

java.lang.Enum<Advice.MetaDataHandler.NoOp>

net.bytebuddy.asm.Advice.MetaDataHandler.NoOp

All Implemented Interfaces:

Serializable, Comparable<Advice.MetaDataHandler.NoOp>, Advice.MetaDataHandler, Advice.MetaDataHandler.ForAdvice, Advice.MetaDataHandler.ForInstrumentedMethod

Enclosing interface:

Advice.MetaDataHandler

public static enum Advice.MetaDataHandler.NoOp
extends Enum<Advice.MetaDataHandler.NoOp>
implements Advice.MetaDataHandler.ForInstrumentedMethod, Advice.MetaDataHandler.ForAdvice

A non-operational meta data handler that does not translate any frames and does not compute stack sizes.

Nested Class Summary

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Field Summary

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

UNDEFINED_SIZE

Method Summary

Modifier and Type	Method and Description
Advice.MetaDataHandler.ForAdvice	bindEntry(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the entry advice.
Advice.MetaDataHandler.ForAdvice	bindExit(MethodDescription.InDefinedShape adviceMethod) Binds this meta data handler for the exit advice.
int	compoundLocalVariableLength(int localVariableLength) Computes a compound local variable array length for the advice and the translated instrumented method.
int	compoundStackSize(int stackSize) Computes a compound stack size for the advice and the translated instrumented method.
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.
void	injectHandlerFrame(MethodVisitor methodVisitor) Injects a frame for a method's exception handler.
void	recordMaxima(int maxStack, int maxLocals) Records the maximum values for stack size and local variable array which are required by the advice method for its individual execution without translation.
void	recordPadding(int padding) Records a minimum padding additionally to the computed stack size that is required for implementing this advice method.
String	toString()
void	translateFrame(MethodVisitor methodVisitor, int frameType, int localVariableLength, Object[] localVariable, int stackSize, Object[] stack) Translates a frame.
static Advice.MetaDataHandler.NoOp	valueOf(String name) Returns the enum constant of this type with the specified name.
static Advice.MetaDataHandler.NoOp[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final Advice.MetaDataHandler.NoOp INSTANCE

The singleton instance.

Method Detail

values

public static Advice.MetaDataHandler.NoOp[] 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 (Advice.MetaDataHandler.NoOp c : Advice.MetaDataHandler.NoOp.values())
    System.out.println(c);

Returns:

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

valueOf

public static Advice.MetaDataHandler.NoOp 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

recordMaxima

public void recordMaxima(int maxStack,
                         int maxLocals)

Description copied from interface: Advice.MetaDataHandler.ForAdvice

Records the maximum values for stack size and local variable array which are required by the advice method for its individual execution without translation.

Specified by:

recordMaxima in interface Advice.MetaDataHandler.ForAdvice

Parameters:

maxStack - The minimum required stack size.

maxLocals - The minimum required length of the local variable array.

recordPadding

public void recordPadding(int padding)

Description copied from interface: Advice.MetaDataHandler.ForAdvice

Records a minimum padding additionally to the computed stack size that is required for implementing this advice method.

Specified by:

recordPadding in interface Advice.MetaDataHandler.ForAdvice

Parameters:

padding - The minimum required padding.

compoundStackSize

public int compoundStackSize(int stackSize)

Description copied from interface: Advice.MetaDataHandler.ForInstrumentedMethod

Computes a compound stack size for the advice and the translated instrumented method.

Specified by:

compoundStackSize in interface Advice.MetaDataHandler.ForInstrumentedMethod

Parameters:

stackSize - The required stack size of the instrumented method before translation.

Returns:

The stack size required by the instrumented method and its advice methods.

compoundLocalVariableLength

public int compoundLocalVariableLength(int localVariableLength)

Description copied from interface: Advice.MetaDataHandler.ForInstrumentedMethod

Computes a compound local variable array length for the advice and the translated instrumented method.

Specified by:

compoundLocalVariableLength in interface Advice.MetaDataHandler.ForInstrumentedMethod

Parameters:

localVariableLength - The required local variable array length of the instrumented method before translation.

Returns:

The local variable length required by the instrumented method and its advice methods.

bindEntry

public Advice.MetaDataHandler.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.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.

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

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.

toString

public String toString()

Overrides:

toString in class Enum<Advice.MetaDataHandler.NoOp>