ClassRefTypeSignature

java.lang.Object
- io.github.classgraph.HierarchicalTypeSignature
- - io.github.classgraph.TypeSignature
  - - io.github.classgraph.ReferenceTypeSignature
    - - io.github.classgraph.ClassRefOrTypeVariableSignature
      - io.github.classgraph.ClassRefTypeSignature

```
public final class ClassRefTypeSignature
extends ClassRefOrTypeVariableSignature
```
A class reference type signature (called "ClassTypeSignature" in the classfile documentation).

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

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.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`java.lang.String`	`getBaseClassName()` Get the name of the class, without any suffixes.
`ClassInfo`	`getClassInfo()` Get the `ClassInfo` object for the referenced class.
`protected java.lang.String`	`getClassName()` The name of the class (used by `getClassInfo()` to fetch the `ClassInfo` object for the class).
`java.lang.String`	`getFullyQualifiedClassName()` Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments.
`java.util.List<java.lang.String>`	`getSuffixes()` Get all nested suffixes of the class (typically nested inner class names).
`java.util.List<AnnotationInfoList>`	`getSuffixTypeAnnotationInfo()` Get a list of lists of type annotations for all nested suffixes of the class, one list per suffix.
`java.util.List<java.util.List<TypeArgument>>`	`getSuffixTypeArguments()` Get a list of type arguments for all nested suffixes of the class, one list per suffix.
`java.util.List<TypeArgument>`	`getTypeArguments()` Get any type arguments of the base class.
`int`	`hashCode()`
`java.lang.Class<?>`	`loadClass()` Load the referenced class, if not already loaded, returning a {@code Class
`java.lang.Class<?>`	`loadClass(boolean ignoreExceptions)` Load the referenced class, if not already loaded, returning a {@code Class
`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.

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
  - getBaseClassName
```
public java.lang.String getBaseClassName()
```
    Get the name of the class, without any suffixes.
    
    Returns:
    
    The name of the class.
    
    See Also:
    
    getFullyQualifiedClassName()
  - getFullyQualifiedClassName
```
public java.lang.String getFullyQualifiedClassName()
```
    Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments. For example, "xyz.Cls<String>.InnerCls<Integer>" is returned as "xyz.Cls$InnerCls". The intent of this method is that if you replace '.' with '/', and then add the suffix ".class", you end up with the path of the classfile relative to the package root.
    For comparison, toString() uses '.' to separate suffixes, and includes type parameters, whereas this method uses '$' to separate suffixes, and does not include type parameters.
    
    Returns:
    
    The fully-qualified name of the class, including suffixes but without type arguments.
  - getTypeArguments
```
public java.util.List<TypeArgument> getTypeArguments()
```
    Get any type arguments of the base class.
    
    Returns:
    
    The type arguments for the base class.
  - getSuffixes
```
public java.util.List<java.lang.String> getSuffixes()
```
    Get all nested suffixes of the class (typically nested inner class names).
    
    Returns:
    
    The class suffixes (for inner classes), or the empty list if none.
  - getSuffixTypeArguments
```
public java.util.List<java.util.List<TypeArgument>> getSuffixTypeArguments()
```
    Get a list of type arguments for all nested suffixes of the class, one list per suffix.
    
    Returns:
    
    The list of type arguments for the suffixes (nested inner classes), one list per suffix, or the empty list if none.
  - getSuffixTypeAnnotationInfo
```
public java.util.List<AnnotationInfoList> getSuffixTypeAnnotationInfo()
```
    Get a list of lists of type annotations for all nested suffixes of the class, one list per suffix.
    
    Returns:
    
    The list of lists of type annotations for the suffixes (nested inner classes), one list per suffix, or null if none.
  - 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.
  - loadClass
```
public java.lang.Class<?> loadClass(boolean ignoreExceptions)
```
    Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class. (Called by AnnotationClassRef.loadClass().)
    
    Parameters:
    
    ignoreExceptions - if true, ignore exceptions and instead return null if the class could not be loaded.
    
    Returns:
    
    The Class<?> reference for the referenced class.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the class could not be loaded and ignoreExceptions was false.
  - loadClass
```
public java.lang.Class<?> loadClass()
```
    Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class. (Called by AnnotationClassRef.loadClass().)
    
    Returns:
    
    The Class<?> reference for the referenced class.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the class could not be loaded.
  - getClassName
```
protected java.lang.String getClassName()
```
    The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
    
    Returns:
    
    the fully-qualified class name, for classloading.
  - getClassInfo
```
public ClassInfo getClassInfo()
```
    Get the ClassInfo object for the referenced class.
    
    Returns:
    
    The ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. if no ClassInfo object was created for the class during scanning). N.B. even if this method returns null, loadClass() may be able to load the referenced class by 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.
  - 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.

Class ClassRefTypeSignature

Field Summary

Fields inherited from class io.github.classgraph.HierarchicalTypeSignature

Method Summary

Methods inherited from class io.github.classgraph.TypeSignature

Methods inherited from class io.github.classgraph.HierarchicalTypeSignature

Methods inherited from class java.lang.Object

Field Detail

scanResult

classRef

Method Detail

getBaseClassName

getFullyQualifiedClassName

getTypeArguments

getSuffixes

getSuffixTypeArguments

getSuffixTypeAnnotationInfo

addTypeAnnotation

loadClass

loadClass

getClassName

getClassInfo

findReferencedClassNames

hashCode

equals

equalsIgnoringTypeParams

toStringInternal

toStringWithSimpleNames

toString