Class MethodInfo

java.lang.Object

edu.umd.cs.findbugs.classfile.FieldOrMethodDescriptor

edu.umd.cs.findbugs.classfile.MethodDescriptor

edu.umd.cs.findbugs.classfile.analysis.MethodInfo

All Implemented Interfaces:

AccessibleEntity, ClassMember, ComparableMethod, XMethod, AnnotatedObject, FieldOrMethodName, Serializable, Comparable<ComparableMethod>

public class MethodInfo
extends MethodDescriptor
implements XMethod

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MethodInfo.Builder
static class	MethodInfo.MethodInfoDatabase

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	accessFlags
static final MethodInfo[]	EMPTY_ARRAY
(package private) final String[]	exceptions
(package private) final boolean	hasBackBranch
(package private) final boolean	hasPolymorphicSignature
(package private) final boolean	isStub
(package private) Map<ClassDescriptor, AnnotationValue>	methodAnnotations
(package private) final int	methodCallCount
(package private) Map<Integer, Map<ClassDescriptor, AnnotationValue>>	methodParameterAnnotations
(package private) final String	methodSourceSignature
(package private) final boolean	usesConcurrency
(package private) final long	variableIsSynthetic

Constructor Summary

Constructors

Constructor

Description

MethodInfo(String className, String methodName, String methodSignature, String methodSourceSignature, int accessFlags, boolean isUnconditionalThrower, boolean isUnsupported, boolean usesConcurrency, boolean hasBackBranch, boolean isStub, boolean isIdentity, boolean usesInvokeDynamic, int methodCallCount, String[] exceptions, MethodDescriptor accessMethodForMethod, FieldDescriptor accessMethodForField, Map<ClassDescriptor, AnnotationValue> methodAnnotations, Map<Integer, Map<ClassDescriptor, AnnotationValue>> methodParameterAnnotations, long variableIsSynthetic)

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(AnnotationValue annotationValue)	Destructively add an annotation.
void	addParameterAnnotation(int param, AnnotationValue annotationValue)	Destructively add a parameter annotation.
XMethod	bridgeFrom()
XMethod	bridgeTo()	If nonnull, then this method is a synthetic method that overrides a method in a superclass.
private boolean	checkFlag(int flag)
int	compareTo(ComparableMethod rhs)
private boolean	computeHasPolymorphicSignature(Map<ClassDescriptor, AnnotationValue> methodAnnotations)
int	getAccessFlags()	Get the entity's access flags.
(package private) static IdentityHashMap<MethodInfo, FieldDescriptor>	getAccessmethodforfield()
FieldDescriptor	getAccessMethodForField()
(package private) static IdentityHashMap<MethodInfo, MethodDescriptor>	getAccessmethodformethod()
MethodDescriptor	getAccessMethodForMethod()
AnnotationValue	getAnnotation(ClassDescriptor desc)	Get the AnnotationValue of annotation applied directly to the method.
Collection<ClassDescriptor>	getAnnotationDescriptors()	Get ClassDescriptors (annotation classes) of annotations applied directly to this method.
Collection<AnnotationValue>	getAnnotations()	Get collection of all AnnotationValues applied directly to the method.
String	getClassName()	Get the full (dotted) name of the class (if the object represents a class) or the class the entity is defined in (if a field or method).
AnnotatedObject	getContainingScope()
(package private) static MethodInfo.MethodInfoDatabase	getDatabase()
ElementType	getElementType()
(package private) static IdentityHashMap<MethodInfo, Void>	getIdentitymethods()
static IdentityHashMap<MethodInfo, Void>	getInvokeDynamicMethods()
int	getMethodCallCount()
MethodDescriptor	getMethodDescriptor()
int	getNumParams()
String	getPackageName()	Get the (dotted) name of the package in which the entity is defined.
AnnotationValue	getParameterAnnotation(int param, ClassDescriptor desc)	Get the AnnotationValue of annotation applied directly to given parameter.
Collection<ClassDescriptor>	getParameterAnnotationDescriptors(int param)	Get ClassDescriptors (annotation classes) of annotations applied directly to this method's parameters.
Collection<AnnotationValue>	getParameterAnnotations(int param)	Get collection of all AnnotationValues applied directly to given parameter.
String	getSourceSignature()	Get the signature representing the field/method's type, including generic type
String[]	getThrownExceptions()
(package private) static IdentityHashMap<MethodInfo, Void>	getUnconditionalthrowers()
(package private) static IdentityHashMap<MethodInfo, Void>	getUnsupportedmethods()
boolean	hasBackBranch()
boolean	hasParameterAnnotations()
boolean	hasPolymorphicSignature()	See java.lang.invoke.MethodHandle.PolymorphicSignature
boolean	isAbstract()
boolean	isBridge()	Is this a bridge method?
boolean	isDeprecated()	Is the entity deprecated?
boolean	isFinal()	Is the entity final?
boolean	isIdentity()	Is this an identity method
boolean	isNative()
boolean	isPrivate()	Is the entity private?
boolean	isProtected()	Is the entity protected?
boolean	isPublic()	Is the entity public?
boolean	isResolved()	Did we find a declaration of this entity?
boolean	isReturnTypeReferenceType()
boolean	isStub()
boolean	isSynchronized()
boolean	isSynthetic()	Is the entity synthetic?
boolean	isUnconditionalThrower()
boolean	isUnsupported()
boolean	isVarArgs()
boolean	isVariableSynthetic(int param)	Is the variable synthetic?
static MethodInfo[]	newArray(int sz)
XMethod	resolveAccessMethodForMethod()
boolean	usesConcurrency()
boolean	usesInvokeDynamic()
MethodInfo	withSignature(String otherMethodSignature)

Methods inherited from class MethodDescriptor

equals, isAccessMethod

Methods inherited from class FieldOrMethodDescriptor

compareTo, compareTo, getClassDescriptor, getName, getNameSigHashCode, getNameSigHashCode, getSignature, getSlashedClassName, hashCode, haveEqualFields, isStatic, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AccessibleEntity

getClassDescriptor, isStatic

Methods inherited from interface AnnotatedObject

getClassDescriptor

Methods inherited from interface ClassMember

getName, getSignature

Methods inherited from interface FieldOrMethodName

getClassDescriptor, isStatic

Methods inherited from interface XMethod

isAccessMethod

Field Details

EMPTY_ARRAY

public static final MethodInfo[] EMPTY_ARRAY

accessFlags

final int accessFlags

variableIsSynthetic

final long variableIsSynthetic

methodCallCount

final int methodCallCount

usesConcurrency

final boolean usesConcurrency

hasBackBranch

final boolean hasBackBranch

isStub

final boolean isStub

hasPolymorphicSignature

final boolean hasPolymorphicSignature

methodSourceSignature

final String methodSourceSignature

exceptions

@CheckForNull
final String[] exceptions

methodAnnotations

Map<ClassDescriptor, AnnotationValue> methodAnnotations

methodParameterAnnotations

Map<Integer, Map<ClassDescriptor, AnnotationValue>> methodParameterAnnotations

Constructor Details

MethodInfo

MethodInfo(@SlashedClassName
 String className,
 String methodName,
 String methodSignature,
 String methodSourceSignature,
 int accessFlags,
 boolean isUnconditionalThrower,
 boolean isUnsupported,
 boolean usesConcurrency,
 boolean hasBackBranch,
 boolean isStub,
 boolean isIdentity,
 boolean usesInvokeDynamic,
 int methodCallCount,
 @CheckForNull
 String[] exceptions,
 @CheckForNull
 MethodDescriptor accessMethodForMethod,
 @CheckForNull
 FieldDescriptor accessMethodForField,
 Map<ClassDescriptor, AnnotationValue> methodAnnotations,
 Map<Integer, Map<ClassDescriptor, AnnotationValue>> methodParameterAnnotations,
 long variableIsSynthetic)

Method Details

newArray

public static MethodInfo[] newArray(int sz)

getDatabase

static MethodInfo.MethodInfoDatabase getDatabase()

Returns:

Returns the database.

getUnconditionalthrowers

static IdentityHashMap<MethodInfo, Void> getUnconditionalthrowers()

getUnsupportedmethods

static IdentityHashMap<MethodInfo, Void> getUnsupportedmethods()

getAccessmethodformethod

static IdentityHashMap<MethodInfo, MethodDescriptor> getAccessmethodformethod()

getAccessmethodforfield

static IdentityHashMap<MethodInfo, FieldDescriptor> getAccessmethodforfield()

getIdentitymethods

static IdentityHashMap<MethodInfo, Void> getIdentitymethods()

getInvokeDynamicMethods

public static IdentityHashMap<MethodInfo, Void> getInvokeDynamicMethods()

computeHasPolymorphicSignature

private boolean computeHasPolymorphicSignature(Map<ClassDescriptor, AnnotationValue> methodAnnotations)

getThrownExceptions

@CheckForNull
public String[] getThrownExceptions()

Specified by:

getThrownExceptions in interface XMethod

Returns:

the exceptions this method is declared to throw

isUnconditionalThrower

public boolean isUnconditionalThrower()

Specified by:

isUnconditionalThrower in interface XMethod

Returns:

does this method unconditionally throw an exception?

isIdentity

public boolean isIdentity()

Description copied from interface: XMethod

Is this an identity method

Specified by:

isIdentity in interface XMethod

usesInvokeDynamic

public boolean usesInvokeDynamic()

Specified by:

usesInvokeDynamic in interface XMethod

isUnsupported

public boolean isUnsupported()

Specified by:

isUnsupported in interface XMethod

Returns:

does this method unconditionally throw an UnsupportedOperationException?

getNumParams

public int getNumParams()

Specified by:

getNumParams in interface XMethod

isVariableSynthetic

public boolean isVariableSynthetic(int param)

Description copied from interface: XMethod

Is the variable synthetic?

Specified by:

isVariableSynthetic in interface XMethod

getMethodCallCount

public int getMethodCallCount()

checkFlag

private boolean checkFlag(int flag)

isNative

public boolean isNative()

Specified by:

isNative in interface XMethod

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface XMethod

isSynchronized

public boolean isSynchronized()

Specified by:

isSynchronized in interface XMethod

isBridge

public boolean isBridge()

Description copied from interface: XMethod

Is this a bridge method?

Specified by:

isBridge in interface XMethod

isReturnTypeReferenceType

public boolean isReturnTypeReferenceType()

Specified by:

isReturnTypeReferenceType in interface XMethod

Returns:

true if method's return type is a reference type, false otherwise

getClassName

@DottedClassName
public String getClassName()

Description copied from interface: ClassMember

Get the full (dotted) name of the class (if the object represents a class) or the class the entity is defined in (if a field or method).

Specified by:

getClassName in interface ClassMember

getPackageName

@DottedClassName
public String getPackageName()

Description copied from interface: ClassMember

Get the (dotted) name of the package in which the entity is defined.

Specified by:

getPackageName in interface ClassMember

getSourceSignature

public String getSourceSignature()

Description copied from interface: ClassMember

Get the signature representing the field/method's type, including generic type

Specified by:

getSourceSignature in interface ClassMember

compareTo

public int compareTo(ComparableMethod rhs)

Specified by:

compareTo in interface Comparable<ComparableMethod>

Overrides:

compareTo in class MethodDescriptor

getAccessFlags

public int getAccessFlags()

Description copied from interface: AccessibleEntity

Get the entity's access flags.

Specified by:

getAccessFlags in interface AccessibleEntity

isFinal

public boolean isFinal()

Description copied from interface: AccessibleEntity

Is the entity final?

Specified by:

isFinal in interface AccessibleEntity

isPrivate

public boolean isPrivate()

Description copied from interface: AccessibleEntity

Is the entity private?

Specified by:

isPrivate in interface AccessibleEntity

isDeprecated

public boolean isDeprecated()

Description copied from interface: AccessibleEntity

Is the entity deprecated?

Specified by:

isDeprecated in interface AccessibleEntity

isProtected

public boolean isProtected()

Description copied from interface: AccessibleEntity

Is the entity protected?

Specified by:

isProtected in interface AccessibleEntity

isPublic

public boolean isPublic()

Description copied from interface: AccessibleEntity

Is the entity public?

Specified by:

isPublic in interface AccessibleEntity

isSynthetic

public boolean isSynthetic()

Description copied from interface: AccessibleEntity

Is the entity synthetic?

Specified by:

isSynthetic in interface AccessibleEntity

Specified by:

isSynthetic in interface AnnotatedObject

isResolved

public boolean isResolved()

Description copied from interface: ClassMember

Did we find a declaration of this entity?

Specified by:

isResolved in interface ClassMember

getParameterAnnotationDescriptors

public Collection<ClassDescriptor> getParameterAnnotationDescriptors(int param)

Description copied from interface: XMethod

Get ClassDescriptors (annotation classes) of annotations applied directly to this method's parameters.

Specified by:

getParameterAnnotationDescriptors in interface XMethod

Parameters:

param - parameter number (0 for first parameter)

Returns:

ClassDescriptors of annotations applied directly to this method's parameters

hasParameterAnnotations

public boolean hasParameterAnnotations()

Specified by:

hasParameterAnnotations in interface XMethod

getParameterAnnotation

@Nullable
public AnnotationValue getParameterAnnotation(int param,
 ClassDescriptor desc)

Description copied from interface: XMethod

Get the AnnotationValue of annotation applied directly to given parameter.

Specified by:

getParameterAnnotation in interface XMethod

Parameters:

param - parameter number (0 for first parameter)

desc - ClassDescriptor of the annotation class

Returns:

AnnotationValue annotating the parameter, or null if parameter is not annotated with this kind of annotation

getParameterAnnotations

public Collection<AnnotationValue> getParameterAnnotations(int param)

Description copied from interface: XMethod

Get collection of all AnnotationValues applied directly to given parameter.

Specified by:

getParameterAnnotations in interface XMethod

Parameters:

param - parameter number (0 for first parameter)

Returns:

Collection of all AnnotationValues applied directly to given parameter

getAnnotationDescriptors

public Collection<ClassDescriptor> getAnnotationDescriptors()

Description copied from interface: XMethod

Get ClassDescriptors (annotation classes) of annotations applied directly to this method.

Specified by:

getAnnotationDescriptors in interface AnnotatedObject

Specified by:

getAnnotationDescriptors in interface XMethod

Returns:

ClassDescriptors of annotations applied directly to this method

getAnnotation

public AnnotationValue getAnnotation(ClassDescriptor desc)

Description copied from interface: XMethod

Get the AnnotationValue of annotation applied directly to the method.

Specified by:

getAnnotation in interface AnnotatedObject

Specified by:

getAnnotation in interface XMethod

Parameters:

desc - ClassDescriptor of the annotation class

Returns:

AnnotationValue annotating the method, or null if method is not annotated with this kind of annotation

getAnnotations

public Collection<AnnotationValue> getAnnotations()

Description copied from interface: XMethod

Get collection of all AnnotationValues applied directly to the method.

Specified by:

getAnnotations in interface AnnotatedObject

Specified by:

getAnnotations in interface XMethod

Returns:

Collection of all AnnotationValues applied directly to the method

addAnnotation

public void addAnnotation(AnnotationValue annotationValue)

Destructively add an annotation. We do this for "built-in" annotations that might not be directly evident in the code. It's not a great idea in general, but we can get away with it as long as it's done early enough (i.e., before anyone asks what annotations this method has.)

Specified by:

addAnnotation in interface XMethod

Parameters:

annotationValue - an AnnotationValue representing a method annotation

addParameterAnnotation

public void addParameterAnnotation(int param,
 AnnotationValue annotationValue)

Destructively add a parameter annotation.

Specified by:

addParameterAnnotation in interface XMethod

Parameters:

param - parameter (0 == first parameter)

annotationValue - an AnnotationValue representing a parameter annotation

getMethodDescriptor

public MethodDescriptor getMethodDescriptor()

Specified by:

getMethodDescriptor in interface XMethod

Returns:

the MethodDescriptor identifying this object

getElementType

public ElementType getElementType()

Specified by:

getElementType in interface AnnotatedObject

getContainingScope

@CheckForNull
public AnnotatedObject getContainingScope()

Specified by:

getContainingScope in interface AnnotatedObject

isVarArgs

public boolean isVarArgs()

Specified by:

isVarArgs in interface XMethod

Returns:

is this a var args method?

usesConcurrency

public boolean usesConcurrency()

Specified by:

usesConcurrency in interface XMethod

Returns:

does the method directly make use of concurrency/threads/synchronization?

hasBackBranch

public boolean hasBackBranch()

isStub

public boolean isStub()

Specified by:

isStub in interface XMethod

Returns:

is the method a synthetic stub method?

getAccessMethodForMethod

@CheckForNull
public MethodDescriptor getAccessMethodForMethod()

Specified by:

getAccessMethodForMethod in interface XMethod

getAccessMethodForField

@CheckForNull
public FieldDescriptor getAccessMethodForField()

Specified by:

getAccessMethodForField in interface XMethod

bridgeFrom

public XMethod bridgeFrom()

Specified by:

bridgeFrom in interface XMethod

bridgeTo

public XMethod bridgeTo()

Description copied from interface: XMethod

If nonnull, then this method is a synthetic method that overrides a method in a superclass. This method simply forwards the call to the method it bridges to, which is a method with an identical name but possibly co-variant arguments and return values.

Specified by:

bridgeTo in interface XMethod

resolveAccessMethodForMethod

public XMethod resolveAccessMethodForMethod()

Specified by:

resolveAccessMethodForMethod in interface XMethod

hasPolymorphicSignature

public boolean hasPolymorphicSignature()

Description copied from interface: XMethod

See java.lang.invoke.MethodHandle.PolymorphicSignature

Specified by:

hasPolymorphicSignature in interface XMethod

Returns:

is this method polymorphic as defined in MethodHandle

withSignature

public MethodInfo withSignature(String otherMethodSignature)

Parameters:

otherMethodSignature - A method signature, for instance ()Ljava/lang/Object;

Returns:

a new MethodInfo with the given signature