io.github.classgraph

Class HierarchicalTypeSignature

java.lang.Object

io.github.classgraph.HierarchicalTypeSignature

Direct Known Subclasses:

ClassTypeSignature, MethodTypeSignature, TypeArgument, TypeParameter, TypeSignature

public abstract class HierarchicalTypeSignature
extends java.lang.Object

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

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.
protected AnnotationInfoList	typeAnnotationInfo

Constructor Summary

Constructors

Constructor and Description
HierarchicalTypeSignature()

Method Summary

Modifier and Type	Method and Description
protected void	addTypeAnnotation(AnnotationInfo annotationInfo) Add a type annotation.
protected abstract void	addTypeAnnotation(java.util.List<io.github.classgraph.Classfile.TypePathNode> typePath, AnnotationInfo annotationInfo) Add a type annotation.
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 by this object.
protected abstract java.lang.String	getClassName() The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
java.lang.String	toString() Render to string.
protected void	toString(boolean useSimpleNames, java.lang.StringBuilder buf) Render type signature to string.
protected abstract 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 java.lang.Object

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

Field Detail

typeAnnotationInfo

protected AnnotationInfoList typeAnnotationInfo

scanResult

protected transient ScanResult scanResult

The scan result.

classRef

protected transient java.lang.Class<?> classRef

The class ref, once the class is loaded.

Constructor Detail

HierarchicalTypeSignature

public HierarchicalTypeSignature()

Method Detail

addTypeAnnotation

protected void addTypeAnnotation(AnnotationInfo annotationInfo)

Add a type annotation.

Parameters:

annotationInfo - the annotation

addTypeAnnotation

protected abstract void addTypeAnnotation(java.util.List<io.github.classgraph.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,
                                         java.lang.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,
                        java.lang.StringBuilder buf)

Render type signature to string.

Parameters:

useSimpleNames - whether to use simple names for classes.

buf - the StringBuilder to write to.

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 by this object.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

getClassName

protected abstract java.lang.String getClassName()

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

Returns:

The class name.

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.