Class HierarchicalTypeSignature

java.lang.Object

io.github.classgraph.ScanResultObject

io.github.classgraph.HierarchicalTypeSignature

Direct Known Subclasses:

ClassTypeSignature, MethodTypeSignature, TypeArgument, TypeParameter, TypeSignature

public abstract class HierarchicalTypeSignature
extends ScanResultObject

A Java type signature. Subclasses are ClassTypeSignature, MethodTypeSignature, and TypeSignature.

Field Summary

Fields

Modifier and Type	Field	Description
protected AnnotationInfoList	typeAnnotationInfo

Fields inherited from class ScanResultObject

classRef, scanResult

Constructor Summary

Constructors

Constructor	Description
HierarchicalTypeSignature()

Method Summary

Modifier and Type	Method	Description
protected void	addTypeAnnotation(AnnotationInfo annotationInfo)	Add a type annotation.
protected abstract void	addTypeAnnotation(List<Classfile.TypePathNode> typePath, AnnotationInfo annotationInfo)	Add a type annotation.
AnnotationInfoList	getTypeAnnotationInfo()	Get a list of AnnotationInfo objects for any type annotations on this type, or null if none.
(package private) void	setScanResult(ScanResult scanResult)	Set ScanResult backreferences in info objects after scan has completed.
protected void	toString(boolean useSimpleNames, StringBuilder buf)	Render type signature to string.
protected abstract void	toStringInternal(boolean useSimpleNames, AnnotationInfoList annotationsToExclude, StringBuilder buf)	Render type signature to string.

Methods inherited from class ScanResultObject

findReferencedClassInfo, findReferencedClassInfo, getClassInfo, getClassName, loadClass, loadClass, loadClass, loadClass, toString, toString, toStringWithSimpleNames

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

typeAnnotationInfo

protected AnnotationInfoList typeAnnotationInfo

Constructor Details

HierarchicalTypeSignature

public HierarchicalTypeSignature()

Method Details

addTypeAnnotation

protected void addTypeAnnotation(AnnotationInfo annotationInfo)

Add a type annotation.

Parameters:

annotationInfo - the annotation

setScanResult

void setScanResult(ScanResult scanResult)

Description copied from class: ScanResultObject

Set ScanResult backreferences in info objects after scan has completed.

Overrides:

setScanResult in class ScanResultObject

Parameters:

scanResult - the scan result

getTypeAnnotationInfo

public AnnotationInfoList getTypeAnnotationInfo()

Get a list of AnnotationInfo objects for any type annotations on this type, or null if none.

Returns:

a list of AnnotationInfo objects for any type annotations on this type, or null if none.

addTypeAnnotation

protected abstract void addTypeAnnotation(List<Classfile.TypePathNode> typePath,
 AnnotationInfo annotationInfo)

Add a type annotation.

Parameters:

typePath - the type path

annotationInfo - the annotation

toStringInternal

protected abstract void toStringInternal(boolean useSimpleNames,
 AnnotationInfoList annotationsToExclude,
 StringBuilder buf)

Render type signature to string.

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.

toString

protected void toString(boolean useSimpleNames,
 StringBuilder buf)

Render type signature to string.

Specified by:

toString in class ScanResultObject

Parameters:

useSimpleNames - whether to use simple names for classes.

buf - the StringBuilder to write to.