Package net.bytebuddy.asm

The ASM package contains classes that are meant for direct interaction with the ASM API.

See: Description

Interface Summary

Interface	Description
Advice.Dispatcher	A dispatcher for implementing advice.
Advice.Dispatcher.Bound	A bound resolution of an advice method.
Advice.Dispatcher.OffsetMapping	Represents an offset mapping for an advice method to an alternative offset.
Advice.Dispatcher.OffsetMapping.Context	A context for applying an Advice.Dispatcher.OffsetMapping.
Advice.Dispatcher.OffsetMapping.Factory	Represents a factory for creating a Advice.Dispatcher.OffsetMapping for a given parameter.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer	A renderer for an origin pattern element.
Advice.Dispatcher.OffsetMapping.Target	A target offset of an offset mapping.
Advice.Dispatcher.Resolved	Represents a resolved dispatcher.
Advice.Dispatcher.Resolved.ForMethodEnter	Represents a resolved dispatcher for entering a method.
Advice.Dispatcher.Resolved.ForMethodExit	Represents a resolved dispatcher for exiting a method.
Advice.Dispatcher.SuppressionHandler	A suppression handler for optionally suppressing exceptions.
Advice.Dispatcher.SuppressionHandler.Bound	A bound version of a suppression handler that must not be reused.
Advice.Dispatcher.SuppressionHandler.ReturnValueProducer	A producer for a default return value if this is applicable.
Advice.Dispatcher.Unresolved	A dispatcher that is not yet resolved.
Advice.DynamicValue<T extends Annotation>	A dynamic value allows to bind parameters of an Advice method to a custom, constant value.
Advice.MethodSizeHandler	A handler for computing the instrumented method's size.
Advice.MethodSizeHandler.ForAdvice	A method size handler for an advice method.
Advice.StackMapFrameHandler	A handler for computing and translating stack map frames.
Advice.StackMapFrameHandler.ForAdvice	A stack map frame handler for an advice method.
Advice.StackMapFrameHandler.ForInstrumentedMethod	A stack map frame handler for an instrumented method.
AsmVisitorWrapper	A class visitor wrapper is used in order to register an intermediate ASM ClassVisitor which is applied to the main type created by a DynamicType.Builder but not to any AuxiliaryTypes, if any.
AsmVisitorWrapper.ForDeclaredFields.FieldVisitorWrapper	A field visitor wrapper that allows for wrapping a FieldVisitor defining a declared field.
AsmVisitorWrapper.ForDeclaredMethods.MethodVisitorWrapper	A method visitor wrapper that allows for wrapping a MethodVisitor defining a declared method.

Class Summary

Class	Description
Advice	Advice wrappers copy the code of blueprint methods to be executed before and/or after a matched method.
Advice.AdviceVisitor	A method visitor that weaves the advice methods' byte codes.
Advice.AdviceVisitor.WithExitAdvice	An advice visitor that applies exit advice.
Advice.AdviceVisitor.WithExitAdvice.WithExceptionHandling	An advice visitor that captures exceptions by weaving try-catch blocks around user code.
Advice.AdviceVisitor.WithExitAdvice.WithoutExceptionHandling	An advice visitor that does not capture exceptions.
Advice.AdviceVisitor.WithoutExitAdvice	An advice visitor that does not apply exit advice.
Advice.Dispatcher.Delegating	A dispatcher for an advice method that is being invoked from the instrumented method.
Advice.Dispatcher.Delegating.Resolved	A resolved version of a dispatcher.
Advice.Dispatcher.Delegating.Resolved.AdviceMethodWriter	A bound advice method that copies the code by first extracting the exception table and later appending the code of the method without copying any meta data.
Advice.Dispatcher.Delegating.Resolved.AdviceMethodWriter.ForMethodEnter	An advice method writer for a method entry.
Advice.Dispatcher.Delegating.Resolved.AdviceMethodWriter.ForMethodExit	An advice method writer for a method exit.
Advice.Dispatcher.Delegating.Resolved.ForMethodEnter	A resolved dispatcher for implementing method enter advice.
Advice.Dispatcher.Delegating.Resolved.ForMethodExit	A resolved dispatcher for implementing method exit advice.
Advice.Dispatcher.Delegating.Resolved.ForMethodExit.WithExceptionHandler	Implementation of exit advice that handles exceptions.
Advice.Dispatcher.Delegating.Resolved.ForMethodExit.WithoutExceptionHandler	Implementation of exit advice that ignores exceptions.
Advice.Dispatcher.Inlining	A dispatcher for an advice method that is being inlined into the instrumented method.
Advice.Dispatcher.Inlining.CodeTranslationVisitor	A visitor for translating an advice method's byte code for inlining into the instrumented method.
Advice.Dispatcher.Inlining.CodeTranslationVisitor.ForMethodEnter	A code translation visitor that retains the return value of the represented advice method.
Advice.Dispatcher.Inlining.CodeTranslationVisitor.ForMethodExit	A code translation visitor that discards the return value of the represented advice method.
Advice.Dispatcher.Inlining.Resolved	A resolved version of a dispatcher.
Advice.Dispatcher.Inlining.Resolved.ForMethodEnter	A resolved dispatcher for implementing method enter advice.
Advice.Dispatcher.Inlining.Resolved.ForMethodExit	A resolved dispatcher for implementing method exit advice.
Advice.Dispatcher.Inlining.Resolved.ForMethodExit.WithExceptionHandler	Implementation of exit advice that handles exceptions.
Advice.Dispatcher.Inlining.Resolved.ForMethodExit.WithoutExceptionHandler	Implementation of exit advice that ignores exceptions.
Advice.Dispatcher.OffsetMapping.ForEnterValue.Factory	A factory for creating a Advice.Dispatcher.OffsetMapping.ForEnterValue offset mapping.
Advice.Dispatcher.OffsetMapping.ForField	An offset mapping for a field.
Advice.Dispatcher.OffsetMapping.ForField.WithExplicitType	An offset mapping for a field with an explicit declaring type.
Advice.Dispatcher.OffsetMapping.ForField.WithImplicitType	An offset mapping for a field with an implicit declaring type.
Advice.Dispatcher.OffsetMapping.ForOrigin	An offset mapping for the Advice.Origin annotation.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForConstantValue	A renderer for a constant value.
Advice.Dispatcher.OffsetMapping.ForParameter	An offset mapping for a given parameter of the instrumented method.
Advice.Dispatcher.OffsetMapping.ForReturnValue	An offset mapping that provides access to the value that is returned by the instrumented method.
Advice.Dispatcher.OffsetMapping.ForThisReference	An offset mapping that provides access to the this reference of the instrumented method.
Advice.Dispatcher.OffsetMapping.ForThrowable	An offset mapping for accessing a Throwable of the instrumented method.
Advice.Dispatcher.OffsetMapping.ForThrowable.Factory	A factory for accessing an exception that was thrown by the instrumented method.
Advice.Dispatcher.OffsetMapping.ForUserValue<T extends Annotation>	Represents an offset mapping for a user-defined value.
Advice.Dispatcher.OffsetMapping.ForUserValue.Factory<S extends Annotation>	A factory for mapping a user-defined dynamic value.
Advice.Dispatcher.OffsetMapping.Illegal	Represents a factory that throws an exception for a given set of illegal parameter annotations.
Advice.Dispatcher.OffsetMapping.Target.ForBoxedArguments	A target for an offset mapping of an array containing all (boxed) arguments of the instrumented method.
Advice.Dispatcher.OffsetMapping.Target.ForBoxedParameter	A target for an offset mapping that boxes a primitive parameter value.
Advice.Dispatcher.OffsetMapping.Target.ForBoxedParameter.ReadOnly	A target mapping for a boxed parameter that only allows reading the boxed value.
Advice.Dispatcher.OffsetMapping.Target.ForBoxedParameter.ReadWrite	A target mapping for a boxed parameter that allows reading and writing the boxed value.
Advice.Dispatcher.OffsetMapping.Target.ForConstantPoolValue	An offset mapping for a constant pool value.
Advice.Dispatcher.OffsetMapping.Target.ForField	An offset mapping for a field.
Advice.Dispatcher.OffsetMapping.Target.ForField.ReadOnly	A target mapping for a field that is only readable.
Advice.Dispatcher.OffsetMapping.Target.ForField.ReadWrite	A target mapping for a field that is both readable and writable.
Advice.Dispatcher.OffsetMapping.Target.ForParameter	A read-only target mapping.
Advice.Dispatcher.OffsetMapping.Target.ForParameter.ReadOnly	A read-only parameter mapping.
Advice.Dispatcher.OffsetMapping.Target.ForParameter.ReadWrite	A parameter mapping that is both readable and writable.
Advice.Dispatcher.OffsetMapping.Target.ForParameter.ReadWrite.WithCasting	A readable and writable parameter mapping where the assigned value is casted to another type prior to assignment.
Advice.Dispatcher.OffsetMapping.Target.ForSerializedObject	Creates a target that represents a value in form of a serialized field.
Advice.Dispatcher.SuppressionHandler.Suppressing	A suppression handler that suppresses a given throwable type.
Advice.Dispatcher.SuppressionHandler.Suppressing.Bound	An active, bound suppression handler.
Advice.DynamicValue.ForFixedValue	A Advice.DynamicValue implementation that always binds a fixed value.
Advice.MethodSizeHandler.Default	A default implementation for a method size handler.
Advice.StackMapFrameHandler.Default	A default implementation of a stack map frame handler for an instrumented method.
Advice.WithCustomMapping	A builder step for creating an Advice that uses custom mappings of annotations to constant pool values.
AsmVisitorWrapper.AbstractBase	An abstract base implementation of an ASM visitor wrapper that does not set any flags.
AsmVisitorWrapper.Compound	An ordered, immutable chain of AsmVisitorWrappers.
AsmVisitorWrapper.ForDeclaredFields	An ASM visitor wrapper that allows to wrap declared fields of the instrumented type with a AsmVisitorWrapper.ForDeclaredFields.FieldVisitorWrapper.
AsmVisitorWrapper.ForDeclaredFields.Entry	An entry describing a field visitor wrapper paired with a matcher for fields to be wrapped.
AsmVisitorWrapper.ForDeclaredMethods	An ASM visitor wrapper that allows to wrap declared methods of the instrumented type with a AsmVisitorWrapper.ForDeclaredMethods.MethodVisitorWrapper.
AsmVisitorWrapper.ForDeclaredMethods.Entry	An entry describing a method visitor wrapper paired with a matcher for fields to be wrapped.
TypeConstantAdjustment.TypeConstantDissolvingClassVisitor	A class visitor that checks a class file version for its support of storing class constants in the constant pool and remaps such constants on discovery if that is not the case.
TypeConstantAdjustment.TypeConstantDissolvingClassVisitor.TypeConstantDissolvingMethodVisitor	A method visitor that remaps class constants to invocations of Class.forName(String).

Enum Summary

Enum	Description
Advice.Dispatcher.Inactive	An implementation for inactive devise that does not write any byte code.
Advice.Dispatcher.OffsetMapping.Context.ForMethodEntry	A context for an offset mapping describing a method entry.
Advice.Dispatcher.OffsetMapping.Context.ForMethodExit	A context for an offset mapping describing a method exit.
Advice.Dispatcher.OffsetMapping.ForBoxedArguments	An offset mapping for an array containing the (boxed) method arguments.
Advice.Dispatcher.OffsetMapping.ForBoxedReturnValue	An offset mapping for the method's (boxed) return value.
Advice.Dispatcher.OffsetMapping.ForBoxedReturnValue.Factory	A factory for an offset mapping the method's (boxed) return value.
Advice.Dispatcher.OffsetMapping.ForEnterValue	An offset mapping that provides access to the value that is returned by the enter advice.
Advice.Dispatcher.OffsetMapping.ForField.Factory	A factory for a Advice.Dispatcher.OffsetMapping.Target.ForField offset mapping.
Advice.Dispatcher.OffsetMapping.ForIgnored	An offset mapping for a parameter where assignments are fully ignored and that always return the parameter type's default value.
Advice.Dispatcher.OffsetMapping.ForInstrumentedType	Maps the declaring type of the instrumented method.
Advice.Dispatcher.OffsetMapping.ForOrigin.Factory	A factory for a method origin.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForDescriptor	A renderer for a method descriptor.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForJavaSignature	A renderer for a method's Java signature in binary form.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForMethodName	A renderer for a method's internal name.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForReturnTypeName	A renderer for a method's return type in binary form.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForStringRepresentation	A renderer for a method's Object.toString() representation.
Advice.Dispatcher.OffsetMapping.ForOrigin.Renderer.ForTypeName	A renderer for a method declaring type's binary name.
Advice.Dispatcher.OffsetMapping.ForParameter.Factory	A factory for creating a Advice.Dispatcher.OffsetMapping.Target.ForParameter offset mapping.
Advice.Dispatcher.OffsetMapping.ForReturnValue.Factory	A factory for creating a Advice.Dispatcher.OffsetMapping.ForReturnValue offset mapping.
Advice.Dispatcher.OffsetMapping.ForThisReference.Factory	A factory for creating a Advice.Dispatcher.OffsetMapping.ForThisReference offset mapping.
Advice.Dispatcher.OffsetMapping.Target.ForBoxedParameter.BoxingDispatcher	A dispatcher for boxing a primitive value.
Advice.Dispatcher.OffsetMapping.Target.ForDefaultValue	Loads a default value onto the stack or pops the accessed value off it.
Advice.Dispatcher.OffsetMapping.Target.ForNullConstant	Binds a null constant to the target parameter.
Advice.Dispatcher.SuppressionHandler.NoOp	A non-operational suppression handler that does not suppress any method.
Advice.MethodSizeHandler.NoOp	A non-operational method size handler.
Advice.StackMapFrameHandler.Default.TranslationMode	A translation mode that determines how the fixed frames of the instrumented method are written.
Advice.StackMapFrameHandler.NoOp	A non-operational stack map frame handler.
AsmVisitorWrapper.NoOp	A class visitor wrapper that does not apply any changes.
TypeConstantAdjustment	This class visitor wrapper ensures that class files of a version previous to Java 5 do not store class entries in the generated class's constant pool.

Annotation Types Summary

Annotation Type	Description
Advice.Argument	Indicates that the annotated parameter should be mapped to the parameter with index Advice.Argument.value() of the instrumented method.
Advice.BoxedArguments	Indicates that the annotated parameter should be mapped to an array containing a (boxed) version of all arguments of the method being instrumented.
Advice.BoxedReturn	Indicates that the annotated parameter should be mapped to a the return value where primitive types are boxed.
Advice.Enter	Indicates that the annotated parameter should be mapped to the value that is returned by the advice method that is annotated by Advice.OnMethodEnter.
Advice.FieldValue	Indicates that the annotated parameter should be mapped to a field in the scope of the instrumented method.
Advice.Ignored	Indicates that the annotated parameter should always return a default value (i.e.
Advice.OnMethodEnter	Indicates that this method should be inlined before the matched method is invoked.
Advice.OnMethodExit	Indicates that this method should be executed before calling the instrumented method.
Advice.Origin	Indicates that the annotated parameter should be mapped to a string representation of the instrumented method or to a constant representing the Class declaring the method.
Advice.Return	Indicates that the annotated parameter should be mapped to the return value of the instrumented method.
Advice.This	Indicates that the annotated parameter should be mapped to the this reference of the instrumented method.
Advice.Thrown	Indicates that the annotated parameter should be mapped to the return value of the instrumented method.

Package net.bytebuddy.asm Description

The ASM package contains classes that are meant for direct interaction with the ASM API.