io.github.classgraph

Class TypeVariableSignature

java.lang.Object

io.github.classgraph.HierarchicalTypeSignature

io.github.classgraph.TypeSignature

io.github.classgraph.ReferenceTypeSignature

io.github.classgraph.ClassRefOrTypeVariableSignature

io.github.classgraph.TypeVariableSignature

public final class TypeVariableSignature
extends ClassRefOrTypeVariableSignature

A type variable signature.

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 to this type.
boolean	equals(java.lang.Object obj)
boolean	equalsIgnoringTypeParams(TypeSignature other) Compare base types, ignoring generic type parameters.
protected void	findReferencedClassNames(java.util.Set<java.lang.String> refdClassNames) Get the names of any classes referenced in the type signature.
protected java.lang.String	getClassName() Return definingClassName, so that getClassInfo() returns the ClassInfo object for the containing class.
java.lang.String	getName() Get the name of the type variable.
int	hashCode()
TypeParameter	resolve() Look up a type variable (e.g.
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.
java.lang.String	toStringWithTypeBound() Returns the type variable along with its type bound, if available (e.g.

Methods inherited from class io.github.classgraph.TypeSignature

findReferencedClassInfo, getTypeAnnotationInfo

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

getName

public java.lang.String getName()

Get the name of the type variable.

Returns:

The type variable name.

resolve

public TypeParameter resolve()

Look up a type variable (e.g. "T") in the defining method and/or enclosing class' type parameters, and return the type parameter with the same name (e.g. "T extends com.xyz.Cls").

Returns:

the type parameter (e.g. "T extends com.xyz.Cls", or simply "T" if the type parameter does not have any bounds).

Throws:

java.lang.IllegalArgumentException - if a type parameter with the same name as the type variable could not be found in the defining method or the enclosing class.

addTypeAnnotation

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

Description copied from class: TypeSignature

Add a type annotation to this type.

Specified by:

addTypeAnnotation in class TypeSignature

Parameters:

typePath - The type path.

annotationInfo - The annotation to add.

getClassName

protected java.lang.String getClassName()

Return definingClassName, so that getClassInfo() returns the ClassInfo object for the containing class.

Returns:

the defining class name.

findReferencedClassNames

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

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

Overrides:

findReferencedClassNames in class TypeSignature

Parameters:

refdClassNames - the referenced class names.

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

equalsIgnoringTypeParams

public boolean equalsIgnoringTypeParams(TypeSignature other)

Description copied from class: TypeSignature

Compare base types, ignoring generic type parameters.

Specified by:

equalsIgnoringTypeParams in class TypeSignature

Parameters:

other - the other TypeSignature to compare to.

Returns:

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

toStringWithTypeBound

public java.lang.String toStringWithTypeBound()

Returns the type variable along with its type bound, if available (e.g. "X extends xyz.Cls"). You can get this in structured form by calling resolve(). Returns just the type variable if there is no type bound, or if no type bound is known (i.e. if resolve() returns null).

Returns:

The string representation.

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.