ArrayTypeSignature

java.lang.Object
- io.github.classgraph.HierarchicalTypeSignature
- - io.github.classgraph.TypeSignature
  - - io.github.classgraph.ReferenceTypeSignature
    - - io.github.classgraph.ArrayTypeSignature

public class ArrayTypeSignature
extends ReferenceTypeSignature

An array type 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

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.
`ArrayClassInfo`	`getArrayClassInfo()` Return an `ArrayClassInfo` instance for the array class, cast to its superclass.
`protected ClassInfo`	`getClassInfo()` Get the `ClassInfo` object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. no ClassInfo object was created for the class during scanning).
`protected java.lang.String`	`getClassName()` The name of the class (used by `getClassInfo()` to fetch the `ClassInfo` object for the class).
`TypeSignature`	`getElementTypeSignature()` Get the type signature of the innermost element type of the array.
`TypeSignature`	`getNestedType()` Get the nested type, which is another `ArrayTypeSignature` with one dimension fewer, if this array has 2 or more dimensions, otherwise this returns the element type.
`int`	`getNumDimensions()` Get the number of dimensions of the array.
`AnnotationInfoList`	`getTypeAnnotationInfo()` Get a list of `AnnotationInfo` objects for the type annotations on this array type, or null if none.
`java.lang.String`	`getTypeSignatureStr()` Get the raw array type signature string, e.g.
`int`	`hashCode()`
`java.lang.Class<?>`	`loadClass()` Obtain a {@code Class
`java.lang.Class<?>`	`loadClass(boolean ignoreExceptions)` Obtain a {@code Class
`java.lang.Class<?>`	`loadElementClass()` Get a {@code Class
`java.lang.Class<?>`	`loadElementClass(boolean ignoreExceptions)` Get 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

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
  - getTypeSignatureStr
```
public java.lang.String getTypeSignatureStr()
```
    Get the raw array type signature string, e.g. "[[I".
    
    Returns:
    
    the raw array type signature string.
  - getElementTypeSignature
```
public TypeSignature getElementTypeSignature()
```
    Get the type signature of the innermost element type of the array.
    
    Returns:
    
    The type signature of the innermost element type.
  - getNumDimensions
```
public int getNumDimensions()
```
    Get the number of dimensions of the array.
    
    Returns:
    
    The number of dimensions of the array.
  - getNestedType
```
public TypeSignature getNestedType()
```
    Get the nested type, which is another ArrayTypeSignature with one dimension fewer, if this array has 2 or more dimensions, otherwise this returns the element type.
    
    Returns:
    
    The nested type.
  - 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.
  - getTypeAnnotationInfo
```
public AnnotationInfoList getTypeAnnotationInfo()
```
    Get a list of AnnotationInfo objects for the type annotations on this array type, or null if none.
    
    Overrides:
    
    getTypeAnnotationInfo in class TypeSignature
    
    Returns:
    
    a list of AnnotationInfo objects for the type annotations of on this array type, or null if none.
    
    See Also:
    
    if you want to read for type annotations on inner (nested) dimensions of the array type.
  - getClassName
```
protected java.lang.String getClassName()
```
    The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
    
    Returns:
    
    The class name.
  - getClassInfo
```
protected ClassInfo getClassInfo()
```
    Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. 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.
    
    Returns:
    
    The ClassInfo object for the referenced class.
  - getArrayClassInfo
```
public ArrayClassInfo getArrayClassInfo()
```
    Return an ArrayClassInfo instance for the array class, cast to its superclass.
    
    Returns:
    
    the ArrayClassInfo instance.
  - 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.
  - loadElementClass
```
public java.lang.Class<?> loadElementClass(boolean ignoreExceptions)
```
    Get a Class<?> reference for the innermost array element type. Causes the ClassLoader to load the class, if it is not already loaded.
    
    Parameters:
    
    ignoreExceptions - Whether or not to ignore exceptions.
    
    Returns:
    
    a Class<?> reference for the innermost array element type. Also works for arrays of primitive element type.
  - loadElementClass
```
public java.lang.Class<?> loadElementClass()
```
    Get a Class<?> reference for the array element type. Causes the ClassLoader to load the element class, if it is not already loaded.
    
    Returns:
    
    a Class<?> reference for the array element type. Also works for arrays of primitive element type.
  - loadClass
```
public java.lang.Class<?> loadClass(boolean ignoreExceptions)
```
    Obtain a Class<?> reference for the array class named by this ArrayClassInfo object. Causes the ClassLoader to load the element class, if it is not already loaded.
    
    Parameters:
    
    ignoreExceptions - Whether or not to ignore exceptions.
    
    Returns:
    
    The class reference, or null, if ignoreExceptions is true and there was an exception or error loading the class.
    
    Throws:
    
    java.lang.IllegalArgumentException - if ignoreExceptions is false and there were problems loading the class.
  - loadClass
```
public java.lang.Class<?> loadClass()
```
    Obtain a Class<?> reference for the array class named by this ArrayClassInfo object. Causes the ClassLoader to load the element class, if it is not already loaded.
    
    Returns:
    
    The class reference.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were problems loading the class.
  - 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 ArrayTypeSignature

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

getTypeSignatureStr

getElementTypeSignature

getNumDimensions

getNestedType

addTypeAnnotation

getTypeAnnotationInfo

getClassName

getClassInfo

getArrayClassInfo

findReferencedClassNames

loadElementClass

loadElementClass

loadClass

loadClass

hashCode

equals

equalsIgnoringTypeParams

toStringInternal

toStringWithSimpleNames

toString