Top Description Fields Constructors Methods
io.github.classgraph

public abstract Class HierarchicalTypeSignature

extends ScanResultObject
Class Inheritance
Known Direct Subclasses
io.github.classgraph.MethodTypeSignature, io.github.classgraph.TypeArgument, io.github.classgraph.TypeParameter, io.github.classgraph.TypeSignature, io.github.classgraph.ClassTypeSignature
Imports
java.util.List, io.github.classgraph.Classfile.TypePathNode

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

Field Summary

Modifier and TypeField and Description
protected AnnotationInfoList
Inherited from io.github.classgraph.ScanResultObject:
classRefscanResult

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected void
addTypeAnnotation(final AnnotationInfo
the annotation
annotationInfo
)

Add a type annotation.

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

Add a type annotation.

public AnnotationInfoList

Returns:

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

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

pack-priv void
setScanResult(final ScanResult
the scan result
scanResult
)

Overrides io.github.classgraph.ScanResultObject.setScanResult.

Set ScanResult backreferences in info objects after scan has completed.

protected void
toString(final boolean
whether to use simple names for classes.
useSimpleNames
,
final StringBuilder
the StringBuilder to write to.
buf
)

Implements abstract io.github.classgraph.ScanResultObject.toString.

Render type signature to string.

protected abstract void
toStringInternal(final boolean
whether to use simple names for classes.
useSimpleNames
,
AnnotationInfoList
toplevel annotations to exclude, to eliminate duplication (toplevel annotations are both class/field/method annotations and type annotations).
annotationsToExclude
,
StringBuilder
the StringBuilder to write to.
buf
)

Render type signature to string.

Inherited from io.github.classgraph.ScanResultObject:
findReferencedClassInfofindReferencedClassInfogetClassInfogetClassNameloadClassloadClassloadClassloadClasstoStringtoStringtoStringWithSimpleNames

Field Detail

typeAnnotationInfoback to summary
protected AnnotationInfoList typeAnnotationInfo

Constructor Detail

HierarchicalTypeSignatureback to summary
public HierarchicalTypeSignature()

Method Detail

addTypeAnnotationback to summary
protected void addTypeAnnotation(final AnnotationInfo annotationInfo)

Add a type annotation.

Parameters
annotationInfo:AnnotationInfo

the annotation

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

Add a type annotation.

Parameters
typePath:List<Classfile.TypePathNode>

the type path

annotationInfo:AnnotationInfo

the annotation

getTypeAnnotationInfoback to summary
public AnnotationInfoList getTypeAnnotationInfo()

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

Returns:AnnotationInfoList

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

setScanResultback to summary
pack-priv void setScanResult(final ScanResult scanResult)

Overrides io.github.classgraph.ScanResultObject.setScanResult.

Doc from io.github.classgraph.ScanResultObject.setScanResult.

Set ScanResult backreferences in info objects after scan has completed.

Parameters
scanResult:ScanResult

the scan result

Annotations
@Override
toStringback to summary
protected void toString(final boolean useSimpleNames, final StringBuilder buf)

Implements abstract io.github.classgraph.ScanResultObject.toString.

Render type signature to string.

Parameters
useSimpleNames:boolean

whether to use simple names for classes.

buf:StringBuilder

the StringBuilder to write to.

Annotations
@Override
toStringInternalback to summary
protected abstract void toStringInternal(final boolean useSimpleNames, AnnotationInfoList annotationsToExclude, StringBuilder buf)

Render type signature to string.

Parameters
useSimpleNames:boolean

whether to use simple names for classes.

annotationsToExclude:AnnotationInfoList

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

buf:StringBuilder

the StringBuilder to write to.