io.github.classgraph

Class TypeSignature

java.lang.Object

io.github.classgraph.HierarchicalTypeSignature

io.github.classgraph.TypeSignature

Direct Known Subclasses:

BaseTypeSignature, ReferenceTypeSignature

public abstract class TypeSignature
extends HierarchicalTypeSignature

A type signature for a reference type or base type. Subclasses are ReferenceTypeSignature (whose own subclasses are ClassRefTypeSignature, TypeVariableSignature, and ArrayTypeSignature), and BaseTypeSignature.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypeSignature() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addTypeAnnotation(java.util.List<io.github.classgraph.Classfile.TypePathNode> typePath, AnnotationInfo annotationInfo) Add a type annotation to this type.
abstract boolean	equalsIgnoringTypeParams(TypeSignature other) Compare base types, ignoring generic type parameters.
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 signature.
protected void	findReferencedClassNames(java.util.Set<java.lang.String> refdClassNames) Get the names of any classes referenced in the type signature.
protected abstract java.lang.String	getClassName() The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
AnnotationInfoList	getTypeAnnotationInfo() Get a list of AnnotationInfo objects for any type annotations on this type, or null if none.
java.lang.String	toString() Render 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, toStringInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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.

Constructor Detail

TypeSignature

protected TypeSignature()

Constructor.

Method Detail

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 final 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 signature.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info.

log - the log

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.

equalsIgnoringTypeParams

public abstract boolean equalsIgnoringTypeParams(TypeSignature other)

Compare base types, ignoring generic type parameters.

Parameters:

other - the other TypeSignature to compare to.

Returns:

True if the two TypeSignature objects are equal, ignoring type parameters.

addTypeAnnotation

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

Add a type annotation to this type.

Specified by:

addTypeAnnotation in class HierarchicalTypeSignature

Parameters:

typePath - The type path.

annotationInfo - The annotation to add.

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.