io.github.classgraph

Class MethodTypeSignature

java.lang.Object

io.github.classgraph.HierarchicalTypeSignature

io.github.classgraph.MethodTypeSignature

public final class MethodTypeSignature
extends HierarchicalTypeSignature

A method type signature (called "MethodSignature" in the classfile documentation).

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 inherited from class io.github.classgraph.HierarchicalTypeSignature

typeAnnotationInfo

Method Summary

Modifier and Type	Method and Description
protected void	addTypeAnnotation(java.util.List<io.github.classgraph.Classfile.TypePathNode> typePath, AnnotationInfo annotationInfo) Add a type annotation.
boolean	equals(java.lang.Object obj)
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.
protected void	findReferencedClassNames(java.util.Set<java.lang.String> refdClassNames) Get the names of any classes referenced in the type signature.
protected ClassInfo	getClassInfo() Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. no ClassInfo object was created for the class during scanning).
protected java.lang.String	getClassName() The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
AnnotationInfoList	getReceiverTypeAnnotationInfo() Get type annotations on the explicit receiver parameter, or null if none.
TypeSignature	getResultType() Get the result type for the method.
java.util.List<ClassRefOrTypeVariableSignature>	getThrowsSignatures() Get the throws type(s) for the method.
java.util.List<TypeParameter>	getTypeParameters() Get the type parameters for the method, if this is a generic method.
int	hashCode()
java.lang.String	toString() Render to string.
protected void	toStringInternal(boolean useSimpleNames, AnnotationInfoList annotationsToExclude, java.lang.StringBuilder buf) Render type signature to string.
java.lang.String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class io.github.classgraph.HierarchicalTypeSignature

addTypeAnnotation, toString

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

getTypeParameters

public java.util.List<TypeParameter> getTypeParameters()

Get the type parameters for the method, if this is a generic method.

Returns:

The type parameters for the method, if any, otherwise null.

getResultType

public TypeSignature getResultType()

Get the result type for the method.

Returns:

The result type for the method, as a TypeSignature parsed type object.

getThrowsSignatures

public java.util.List<ClassRefOrTypeVariableSignature> getThrowsSignatures()

Get the throws type(s) for the method.

Returns:

The throws types for the method, as TypeSignature parsed type objects.

addTypeAnnotation

protected void addTypeAnnotation(java.util.List<io.github.classgraph.Classfile.TypePathNode> typePath,
                                 AnnotationInfo annotationInfo)

Description copied from class: HierarchicalTypeSignature

Add a type annotation.

Specified by:

addTypeAnnotation in class HierarchicalTypeSignature

Parameters:

typePath - the type path

annotationInfo - the annotation

getReceiverTypeAnnotationInfo

public AnnotationInfoList getReceiverTypeAnnotationInfo()

Get type annotations on the explicit receiver parameter, or null if none.

Returns:

type annotations on the explicit receiver parameter, or null if none.

getClassName

protected java.lang.String getClassName()

The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).

Returns:

The class name.

getClassInfo

protected ClassInfo getClassInfo()

Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. no ClassInfo object was created for the class during scanning). N.B. even if this method returns null, loadClass() may be able to load the referenced class by name.

Returns:

The ClassInfo object for the referenced class.

findReferencedClassNames

protected void findReferencedClassNames(java.util.Set<java.lang.String> refdClassNames)

Get the names of any classes referenced in the type signature.

Parameters:

refdClassNames - the referenced class names.

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toStringInternal

protected void toStringInternal(boolean useSimpleNames,
                                AnnotationInfoList annotationsToExclude,
                                java.lang.StringBuilder buf)

Description copied from class: HierarchicalTypeSignature

Render type signature to string.

Specified by:

toStringInternal in class HierarchicalTypeSignature

Parameters:

useSimpleNames - whether to use simple names for classes.

annotationsToExclude - toplevel annotations to exclude, to eliminate duplication (toplevel annotations are both class/field/method annotations and type annotations).

buf - the StringBuilder to write to.

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.