net.bytebuddy.instrumentation.method

Interface MethodDescription

All Superinterfaces:

AnnotatedElement, ByteCodeElement, ByteCodeMethod, DeclaredInType, ModifierReviewable

All Known Implementing Classes:

InstrumentedType.AbstractBase.MethodToken, MethodDescription.AbstractMethodDescription, MethodDescription.ForLoadedConstructor, MethodDescription.ForLoadedMethod, MethodDescription.Latent, MethodLookupEngine.ConflictingInterfaceMethod, MethodLookupEngine.OverridenClassMethod

public interface MethodDescription
extends ModifierReviewable, ByteCodeMethod, DeclaredInType, AnnotatedElement

Implementations of this interface describe a Java method, i.e. a method or a constructor. Implementations of this interface must provide meaningful equal(Object) and hashCode() implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MethodDescription.AbstractMethodDescription An abstract base implementation of a method description.
static class	MethodDescription.ForLoadedConstructor An implementation of a method description for a loaded constructor.
static class	MethodDescription.ForLoadedMethod An implementation of a method description for a loaded method.
static class	MethodDescription.Latent A latent method description describes a method that is not attached to a declaring TypeDescription.

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.ModifierReviewable

ModifierReviewable.AbstractModifierReviewable

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRUCTOR_INTERNAL_NAME The internal name of a Java constructor.
static String	TYPE_INITIALIZER_INTERNAL_NAME The internal name of a Java static initializer.

Method Summary

Modifier and Type	Method and Description
int	getAdjustedModifiers(boolean nonAbstract) Returns this method modifier but adjusts its state of being abstract.
TypeList	getExceptionTypes() Returns a description of the exception types of the method described by this instance.
Annotation[][]	getParameterAnnotations() Returns the parameter annotations of the method described by this instance.
int	getParameterOffset(int parameterIndex) Returns the offset of the parameter at parameterIndex on the described method's local variable array.
TypeList	getParameterTypes() Returns a list of type descriptions of the method described by this instance.
TypeDescription	getReturnType() Returns a description of the return type of the method described by this instance.
int	getStackSize() Returns the size of the local variable array that is required for this method, i.e.
boolean	isConstructor() Checks if this method description represents a constructor.
boolean	isDefaultMethod() Checks if this method represents a Java 8+ default method.
boolean	isMethod() Checks if this method description represents a method, i.e.
boolean	isOverridable() Verifies if this method description represents an overridable method.
boolean	isSpecializableFor(TypeDescription typeDescription) Checks if this method can be called using the INVOKESPECIAL for a given type.
boolean	isTypeInitializer() Checks if this method is a type initializer.
boolean	represents(Constructor<?> constructor) Verifies if a method description represents a given loaded constructor.
boolean	represents(Method method) Verifies if a method description represents a given loaded method.

Methods inherited from interface net.bytebuddy.instrumentation.ModifierReviewable

getModifiers, isAbstract, isAnnotation, isBridge, isDeprecated, isEnum, isFinal, isInterface, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Methods inherited from interface net.bytebuddy.instrumentation.method.ByteCodeMethod

getUniqueSignature

Methods inherited from interface net.bytebuddy.instrumentation.ByteCodeElement

getDescriptor, getGenericSignature, getInternalName, getName, isVisibleTo

Methods inherited from interface net.bytebuddy.instrumentation.type.DeclaredInType

getDeclaringType

Methods inherited from interface java.lang.reflect.AnnotatedElement

getAnnotation, getAnnotations, getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAnnotationPresent

Field Detail

CONSTRUCTOR_INTERNAL_NAME

static final String CONSTRUCTOR_INTERNAL_NAME

The internal name of a Java constructor.

See Also:

Constant Field Values

TYPE_INITIALIZER_INTERNAL_NAME

static final String TYPE_INITIALIZER_INTERNAL_NAME

The internal name of a Java static initializer.

See Also:

Constant Field Values

Method Detail

getReturnType

TypeDescription getReturnType()

Returns a description of the return type of the method described by this instance.

Returns:

A description of the return type of the method described by this instance.

getParameterTypes

TypeList getParameterTypes()

Returns a list of type descriptions of the method described by this instance.

Returns:

A list of type descriptions of the method described by this instance.

getParameterAnnotations

Annotation[][] getParameterAnnotations()

Returns the parameter annotations of the method described by this instance.

Returns:

The parameter annotations of the method described by this instance.

getExceptionTypes

TypeList getExceptionTypes()

Returns a description of the exception types of the method described by this instance.

Returns:

A description of the exception types of the method described by this instance.

getAdjustedModifiers

int getAdjustedModifiers(boolean nonAbstract)

Returns this method modifier but adjusts its state of being abstract.

Parameters:

nonAbstract - true if the method should be treated as non-abstract.

Returns:

The adjusted modifiers.

isConstructor

boolean isConstructor()

Checks if this method description represents a constructor.

Returns:

true if this method description represents a constructor.

isMethod

boolean isMethod()

Checks if this method description represents a method, i.e. not a constructor or a type initializer.

Returns:

true if this method description represents a method.

isTypeInitializer

boolean isTypeInitializer()

Checks if this method is a type initializer.

Returns:

true if this method description represents a type initializer.

represents

boolean represents(Method method)

Verifies if a method description represents a given loaded method.

Parameters:

method - The method to be checked.

Returns:

true if this method description represents the given loaded method.

represents

boolean represents(Constructor<?> constructor)

Verifies if a method description represents a given loaded constructor.

Parameters:

constructor - The constructor to be checked.

Returns:

true if this method description represents the given loaded constructor.

isOverridable

boolean isOverridable()

Verifies if this method description represents an overridable method.

Returns:

true if this method description represents an overridable method.

getStackSize

int getStackSize()

Returns the size of the local variable array that is required for this method, i.e. the size of all parameters if they were loaded on the stack including a reference to this if this method represented a non-static method.

Returns:

The size of this method on the operand stack.

getParameterOffset

int getParameterOffset(int parameterIndex)

Returns the offset of the parameter at parameterIndex on the described method's local variable array.

Parameters:

parameterIndex - The parameter index of interest.

Returns:

The offset of this parameter.

isDefaultMethod

boolean isDefaultMethod()

Checks if this method represents a Java 8+ default method.

Returns:

true if this method is a default method.

isSpecializableFor

boolean isSpecializableFor(TypeDescription typeDescription)

Checks if this method can be called using the INVOKESPECIAL for a given type.

Parameters:

typeDescription - The type o

Returns:

true if this method can be called using the INVOKESPECIAL instruction using the given type.