MethodInfo

java.lang.Object
- io.github.classgraph.MethodInfo

All Implemented Interfaces:

HasName, java.lang.Comparable<MethodInfo>
```
public class MethodInfo
extends java.lang.Object
implements java.lang.Comparable<MethodInfo>, HasName
```
Holds metadata about methods of a class encountered during a scan. All values are taken directly out of the classfile for the class.

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Class<?> classRef
The class ref, once the class is loaded.

protected ScanResult scanResult
The scan result.

Fields
Modifier and Type	Field and Description
`protected java.lang.Class<?>`	`classRef` The class ref, once the class is loaded.
`protected ScanResult`	`scanResult` The scan result.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(MethodInfo other)` Sort in order of class name, method name, then type descriptor.
`boolean`	`equals(java.lang.Object obj)` Test class name, method name and type descriptor for equals().
`protected void`	`findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log)` Get `ClassInfo` objects for any classes referenced in the type descriptor or type signature.
`AnnotationInfoList`	`getAnnotationInfo()` Get a list of annotations on this method, along with any annotation parameter values.
`AnnotationInfo`	`getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Get a the non-`Repeatable` annotation on this method, or null if the method does not have the annotation.
`AnnotationInfo`	`getAnnotationInfo(java.lang.String annotationName)` Get a the named non-`Repeatable` annotation on this method, or null if the method does not have the named annotation.
`AnnotationInfoList`	`getAnnotationInfoRepeatable(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Get a the `Repeatable` annotation on this method, or the empty list if the method does not have the annotation.
`AnnotationInfoList`	`getAnnotationInfoRepeatable(java.lang.String annotationName)` Get a the named `Repeatable` annotation on this method, or the empty list if the method does not have the named annotation.
`ClassInfo`	`getClassInfo()` Get the `ClassInfo` object for the class that declares this method.
`java.lang.String`	`getClassName()` Get the name of the class that declares this method.
`int`	`getModifiers()` Returns the modifier bits for the method.
`java.lang.String`	`getModifiersStr()` Get the method modifiers as a String, e.g.
`java.lang.String`	`getName()` Returns the name of the method.
`MethodParameterInfo[]`	`getParameterInfo()` Get the available information on method parameters.
`MethodTypeSignature`	`getTypeDescriptor()` Returns the parsed type descriptor for the method, which will not include type parameters.
`java.lang.String`	`getTypeDescriptorStr()` Returns the type descriptor string for the method, which will not include type parameters.
`MethodTypeSignature`	`getTypeSignature()` Returns the parsed type signature for the method, possibly including type parameters.
`MethodTypeSignature`	`getTypeSignatureOrTypeDescriptor()` Returns the parsed type signature for the method, possibly including type parameters.
`java.lang.String`	`getTypeSignatureOrTypeDescriptorStr()` Returns the type signature string for the method, possibly including type parameters.
`java.lang.String`	`getTypeSignatureStr()` Returns the type signature string for the method, possibly including type parameters.
`boolean`	`hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Check if this method has the annotation.
`boolean`	`hasAnnotation(java.lang.String annotationName)` Check if this method has the named annotation.
`boolean`	`hasBody()` Returns true if this method has a body (i.e. has an implementation in the containing class).
`int`	`hashCode()` Use hashcode of class name, method name and type descriptor.
`boolean`	`hasParameterAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Check if this method has a parameter with the annotation.
`boolean`	`hasParameterAnnotation(java.lang.String annotationName)` Check if this method has a parameter with the named annotation.
`boolean`	`isAbstract()` Returns true if this method is abstract.
`boolean`	`isBridge()` Returns true if this method is a bridge method.
`boolean`	`isConstructor()` Returns true if this method is a constructor.
`boolean`	`isDefault()` Returns true if this is a default method (i.e. if this is a method in an interface and the method has a body).
`boolean`	`isFinal()` Returns true if this method is final.
`boolean`	`isNative()` Returns true if this method is a native method.
`boolean`	`isPrivate()` Returns true if this method is private.
`boolean`	`isProtected()` Returns true if this method is protected.
`boolean`	`isPublic()` Returns true if this method is public.
`boolean`	`isStatic()` Returns true if this method is static.
`boolean`	`isStrict()` Returns true if this method is strict.
`boolean`	`isSynchronized()` Returns true if this method is synchronized.
`boolean`	`isSynthetic()` Returns true if this method is synthetic.
`boolean`	`isVarArgs()` Returns true if this method is a varargs method.
`java.lang.reflect.Constructor<?>`	`loadClassAndGetConstructor()` Load the class this constructor is associated with, and get the `Constructor` reference for this constructor.
`java.lang.reflect.Method`	`loadClassAndGetMethod()` Load the class this method is associated with, and get the `Method` reference for this method.
`java.lang.String`	`toString()` Render to string.
`protected void`	`toString(boolean useSimpleNames, java.lang.StringBuilder buf)` Get a string representation of the method.
`java.lang.String`	`toStringWithSimpleNames()` Render to string, using only simple names for classes.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - scanResult
```
protected transient ScanResult scanResult
```
    The scan result.
  - classRef
```
protected transient java.lang.Class<?> classRef
```
    The class ref, once the class is loaded.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of the method. Note that constructors are named "<init>", and private static class initializer blocks are named "<clinit>".
    
    Specified by:
    
    getName in interface HasName
    
    Returns:
    
    The name of the method.
  - getModifiers
```
public int getModifiers()
```
    Returns the modifier bits for the method.
    
    Returns:
    
    The modifier bits for the method.
  - getModifiersStr
```
public java.lang.String getModifiersStr()
```
    Get the method modifiers as a String, e.g. "public static final". For the modifier bits, call getModifiers().
    
    Returns:
    
    The modifiers for the method, as a String.
  - getClassInfo
```
public ClassInfo getClassInfo()
```
    Get the ClassInfo object for the class that declares this method.
    
    Returns:
    
    The ClassInfo object for the declaring class.
    
    See Also:
    
    getClassName()
  - getTypeDescriptor
```
public MethodTypeSignature getTypeDescriptor()
```
    Returns the parsed type descriptor for the method, which will not include type parameters. If you need generic type parameters, call getTypeSignature() instead.
    
    Returns:
    
    The parsed type descriptor for the method.
  - getTypeDescriptorStr
```
public java.lang.String getTypeDescriptorStr()
```
    Returns the type descriptor string for the method, which will not include type parameters. If you need generic type parameters, call getTypeSignatureStr() instead.
    
    Returns:
    
    The type descriptor string for the method.
  - getTypeSignature
```
public MethodTypeSignature getTypeSignature()
```
    Returns the parsed type signature for the method, possibly including type parameters. If this returns null, indicating that no type signature information is available for this method, call getTypeDescriptor() instead.
    
    Returns:
    
    The parsed type signature for the method, or null if not available.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the method type signature cannot be parsed (this should only be thrown in the case of classfile corruption, or a compiler bug that causes an invalid type signature to be written to the classfile).
  - getTypeSignatureStr
```
public java.lang.String getTypeSignatureStr()
```
    Returns the type signature string for the method, possibly including type parameters. If this returns null, indicating that no type signature information is available for this method, call getTypeDescriptorStr() instead.
    
    Returns:
    
    The type signature string for the method, or null if not available.
  - getTypeSignatureOrTypeDescriptor
```
public MethodTypeSignature getTypeSignatureOrTypeDescriptor()
```
    Returns the parsed type signature for the method, possibly including type parameters. If the type signature string is null, indicating that no type signature information is available for this method, returns the parsed type descriptor instead.
    
    Returns:
    
    The parsed type signature for the method, or if not available, the parsed type descriptor for the method.
  - getTypeSignatureOrTypeDescriptorStr
```
public java.lang.String getTypeSignatureOrTypeDescriptorStr()
```
    Returns the type signature string for the method, possibly including type parameters. If the type signature string is null, indicating that no type signature information is available for this method, returns the type descriptor string instead.
    
    Returns:
    
    The type signature string for the method, or if not available, the type descriptor string for the method.
  - isConstructor
```
public boolean isConstructor()
```
    Returns true if this method is a constructor. Constructors have the method name "<init>". This returns false for private static class initializer blocks, which are named "<clinit>".
    
    Returns:
    
    True if this method is a constructor.
  - isPublic
```
public boolean isPublic()
```
    Returns true if this method is public.
    
    Returns:
    
    True if this method is public.
  - isPrivate
```
public boolean isPrivate()
```
    Returns true if this method is private.
    
    Returns:
    
    True if this method is private.
  - isProtected
```
public boolean isProtected()
```
    Returns true if this method is protected.
    
    Returns:
    
    True if this method is protected.
  - isStatic
```
public boolean isStatic()
```
    Returns true if this method is static.
    
    Returns:
    
    True if this method is static.
  - isFinal
```
public boolean isFinal()
```
    Returns true if this method is final.
    
    Returns:
    
    True if this method is final.
  - isSynchronized
```
public boolean isSynchronized()
```
    Returns true if this method is synchronized.
    
    Returns:
    
    True if this method is synchronized.
  - isBridge
```
public boolean isBridge()
```
    Returns true if this method is a bridge method.
    
    Returns:
    
    True if this is a bridge method.
  - isSynthetic
```
public boolean isSynthetic()
```
    Returns true if this method is synthetic.
    
    Returns:
    
    True if this is synthetic.
  - isVarArgs
```
public boolean isVarArgs()
```
    Returns true if this method is a varargs method.
    
    Returns:
    
    True if this is a varargs method.
  - isNative
```
public boolean isNative()
```
    Returns true if this method is a native method.
    
    Returns:
    
    True if this method is native.
  - isAbstract
```
public boolean isAbstract()
```
    Returns true if this method is abstract.
    
    Returns:
    
    True if this method is abstract.
  - isStrict
```
public boolean isStrict()
```
    Returns true if this method is strict.
    
    Returns:
    
    True if this method is strict.
  - hasBody
```
public boolean hasBody()
```
    Returns true if this method has a body (i.e. has an implementation in the containing class).
    
    Returns:
    
    True if this method has a body.
  - isDefault
```
public boolean isDefault()
```
    Returns true if this is a default method (i.e. if this is a method in an interface and the method has a body).
    
    Returns:
    
    True if this is a default method.
  - getParameterInfo
```
public MethodParameterInfo[] getParameterInfo()
```
    Get the available information on method parameters.
    
    Returns:
    
    The MethodParameterInfo objects for the method parameters, one per parameter.
  - getAnnotationInfo
```
public AnnotationInfoList getAnnotationInfo()
```
    Get a list of annotations on this method, along with any annotation parameter values.
    
    Returns:
    
    a list of annotations on this method, along with any annotation parameter values, wrapped in AnnotationInfo objects, or the empty list if none.
  - getAnnotationInfo
```
public AnnotationInfo getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Get a the non-Repeatable annotation on this method, or null if the method does not have the annotation. (Use getAnnotationInfoRepeatable(Class) for Repeatable annotations.)
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    An AnnotationInfo object representing the annotation on this method, or null if the method does not have the annotation.
  - getAnnotationInfo
```
public AnnotationInfo getAnnotationInfo(java.lang.String annotationName)
```
    Get a the named non-Repeatable annotation on this method, or null if the method does not have the named annotation. (Use getAnnotationInfoRepeatable(String) for Repeatable annotations.)
    
    Parameters:
    
    annotationName - The annotation name.
    
    Returns:
    
    An AnnotationInfo object representing the named annotation on this method, or null if the method does not have the named annotation.
  - getAnnotationInfoRepeatable
```
public AnnotationInfoList getAnnotationInfoRepeatable(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Get a the Repeatable annotation on this method, or the empty list if the method does not have the annotation.
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    An AnnotationInfoList containing all instances of the annotation on this method, or the empty list if the method does not have the annotation.
  - getAnnotationInfoRepeatable
```
public AnnotationInfoList getAnnotationInfoRepeatable(java.lang.String annotationName)
```
    Get a the named Repeatable annotation on this method, or the empty list if the method does not have the named annotation.
    
    Parameters:
    
    annotationName - The annotation name.
    
    Returns:
    
    An AnnotationInfoList containing all instances of the named annotation on this method, or the empty list if the method does not have the named annotation.
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Check if this method has the annotation.
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    true if this method has the annotation.
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.String annotationName)
```
    Check if this method has the named annotation.
    
    Parameters:
    
    annotationName - The name of an annotation.
    
    Returns:
    
    true if this method has the named annotation.
  - hasParameterAnnotation
```
public boolean hasParameterAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Check if this method has a parameter with the annotation.
    
    Parameters:
    
    annotation - The method parameter annotation.
    
    Returns:
    
    true if this method has a parameter with the annotation.
  - hasParameterAnnotation
```
public boolean hasParameterAnnotation(java.lang.String annotationName)
```
    Check if this method has a parameter with the named annotation.
    
    Parameters:
    
    annotationName - The name of a method parameter annotation.
    
    Returns:
    
    true if this method has a parameter with the named annotation.
  - loadClassAndGetMethod
```
public java.lang.reflect.Method loadClassAndGetMethod()
                                               throws java.lang.IllegalArgumentException
```
    Load the class this method is associated with, and get the Method reference for this method. Only call this if isConstructor() returns false, otherwise an IllegalArgumentException will be thrown. Instead call loadClassAndGetConstructor() for constructors.
    
    Returns:
    
    The Method reference for this method.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the method does not exist, or if the method is a constructor.
  - loadClassAndGetConstructor
```
public java.lang.reflect.Constructor<?> loadClassAndGetConstructor()
                                                            throws java.lang.IllegalArgumentException
```
    Load the class this constructor is associated with, and get the Constructor reference for this constructor. Only call this if isConstructor() returns true, otherwise an IllegalArgumentException will be thrown. Instead call loadClassAndGetMethod() for non-method constructors.
    
    Returns:
    
    The Constructor reference for this constructor.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the constructor does not exist, or if the method is not a constructor.
  - getClassName
```
public java.lang.String getClassName()
```
    Get the name of the class that declares this method.
    
    Returns:
    
    The name of the declaring class.
    
    See Also:
    
    getClassInfo()
  - findReferencedClassInfo
```
protected void findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo,
                                       java.util.Set<ClassInfo> refdClassInfo,
                                       LogNode log)
```
    Get ClassInfo objects for any classes referenced in the type descriptor or type signature.
    
    Parameters:
    
    classNameToClassInfo - the map from class name to ClassInfo.
    
    refdClassInfo - the referenced class info
    
    log - the log
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Test class name, method name and type descriptor for equals().
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare for equality
    
    Returns:
    
    true if equal
  - hashCode
```
public int hashCode()
```
    Use hashcode of class name, method name and type descriptor.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashcode
  - compareTo
```
public int compareTo(MethodInfo other)
```
    Sort in order of class name, method name, then type descriptor.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<MethodInfo>
    
    Parameters:
    
    other - the other MethodInfo to compare.
    
    Returns:
    
    the result of the comparison.
  - toString
```
protected void toString(boolean useSimpleNames,
                        java.lang.StringBuilder buf)
```
    Get a string representation of the method. Note that constructors are named "<init>", and private static class initializer blocks are named "<clinit>".
    
    Parameters:
    
    useSimpleNames - the use simple names
    
    buf - the buf
  - toStringWithSimpleNames
```
public java.lang.String toStringWithSimpleNames()
```
    Render to string, using only simple names for classes.
    
    Returns:
    
    the string representation, using simple names for classes.
  - toString
```
public java.lang.String toString()
```
    Render to string.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation.

Class MethodInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

scanResult

classRef

Method Detail

getName

getModifiers

getModifiersStr

getClassInfo

getTypeDescriptor

getTypeDescriptorStr

getTypeSignature

getTypeSignatureStr

getTypeSignatureOrTypeDescriptor

getTypeSignatureOrTypeDescriptorStr

isConstructor

isPublic

isPrivate

isProtected

isStatic

isFinal

isSynchronized

isBridge

isSynthetic

isVarArgs

isNative

isAbstract

isStrict

hasBody

isDefault

getParameterInfo

getAnnotationInfo

getAnnotationInfo

getAnnotationInfo

getAnnotationInfoRepeatable

getAnnotationInfoRepeatable

hasAnnotation

hasAnnotation

hasParameterAnnotation

hasParameterAnnotation

loadClassAndGetMethod

loadClassAndGetConstructor

getClassName

findReferencedClassInfo

equals

hashCode

compareTo

toString

toStringWithSimpleNames

toString