io.github.classgraph

Class ArrayClassInfo

java.lang.Object

io.github.classgraph.ClassInfo

io.github.classgraph.ArrayClassInfo

All Implemented Interfaces:

HasName, java.lang.Comparable<ClassInfo>

public class ArrayClassInfo
extends ClassInfo

Holds metadata about an array class. This class extends ClassInfo with additional methods relevant to array classes, in particular getArrayTypeSignature(), getTypeSignatureStr(), getElementTypeSignature(), getElementClassInfo(), loadElementClass(), and getNumDimensions().

An ArrayClassInfo object will not have any methods, fields or annotations. ClassInfo.isArrayClass() will return true for this subclass of ClassInfo.

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.ClassInfo

classfileResource, isExternalClass, isScannedClass, name, typeSignatureStr

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Use class name for equals().
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 descriptor or type signature.
ArrayTypeSignature	getArrayTypeSignature() Get the type signature of the class.
ClassInfo	getElementClassInfo() Get the ClassInfo instance for the array element type.
TypeSignature	getElementTypeSignature() Get the type signature of the array elements.
int	getNumDimensions() Get the number of dimensions of the array.
ClassTypeSignature	getTypeSignature() Returns null, because array classes do not have a ClassTypeSignature.
java.lang.String	getTypeSignatureStr() Get the raw type signature string of the array class, e.g.
int	hashCode() Use hash code of class name.
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.
java.lang.String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class io.github.classgraph.ClassInfo

compareTo, extendsSuperclass, extendsSuperclass, getAnnotationDefaultParameterValues, getAnnotationInfo, getAnnotationInfo, getAnnotationInfo, getAnnotationInfoRepeatable, getAnnotationInfoRepeatable, getAnnotations, getClassDependencies, getClassesImplementing, getClassesWithAnnotation, getClassesWithFieldAnnotation, getClassesWithMethodAnnotation, getClassesWithMethodParameterAnnotation, getClassfileMajorVersion, getClassfileMinorVersion, getClassInfo, getClassName, getClasspathElementFile, getClasspathElementURI, getClasspathElementURL, getConstructorInfo, getDeclaredConstructorInfo, getDeclaredFieldInfo, getDeclaredFieldInfo, getDeclaredMethodAndConstructorInfo, getDeclaredMethodInfo, getDeclaredMethodInfo, getEnumConstantObjects, getEnumConstants, getFieldAnnotations, getFieldInfo, getFieldInfo, getFullyQualifiedDefiningMethodName, getInnerClasses, getInterfaces, getMethodAndConstructorInfo, getMethodAnnotations, getMethodInfo, getMethodInfo, getMethodParameterAnnotations, getModifiers, getModifiersStr, getModuleInfo, getModuleRef, getName, getOuterClasses, getPackageInfo, getPackageName, getResource, getSimpleName, getSubclasses, getSuperclass, getSuperclasses, hasAnnotation, hasAnnotation, hasDeclaredField, hasDeclaredFieldAnnotation, hasDeclaredFieldAnnotation, hasDeclaredMethod, hasDeclaredMethodAnnotation, hasDeclaredMethodAnnotation, hasDeclaredMethodParameterAnnotation, hasDeclaredMethodParameterAnnotation, hasField, hasFieldAnnotation, hasFieldAnnotation, hasMethod, hasMethodAnnotation, hasMethodAnnotation, hasMethodParameterAnnotation, hasMethodParameterAnnotation, implementsInterface, implementsInterface, isAbstract, isAnnotation, isAnonymousInnerClass, isArrayClass, isEnum, isExternalClass, isFinal, isImplementedInterface, isInnerClass, isInterface, isInterfaceOrAnnotation, isOuterClass, isPrivate, isProtected, isPublic, isRecord, isStandardClass, isStatic, isSynthetic, loadClass, loadClass, 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 type signature string of the array class, e.g. "[[I" for "int[][]".

Overrides:

getTypeSignatureStr in class ClassInfo

Returns:

The raw type signature string of the array class.

getTypeSignature

public ClassTypeSignature getTypeSignature()

Returns null, because array classes do not have a ClassTypeSignature. Call getArrayTypeSignature() instead.

Overrides:

getTypeSignature in class ClassInfo

Returns:

null (always).

getArrayTypeSignature

public ArrayTypeSignature getArrayTypeSignature()

Get the type signature of the class.

Returns:

The class type signature, if available, otherwise returns null.

getElementTypeSignature

public TypeSignature getElementTypeSignature()

Get the type signature of the array elements.

Returns:

The type signature of the array elements.

getNumDimensions

public int getNumDimensions()

Get the number of dimensions of the array.

Returns:

The number of dimensions of the array.

getElementClassInfo

public ClassInfo getElementClassInfo()

Get the ClassInfo instance for the array element type.

Returns:

the ClassInfo instance for the array element type. Returns null if the element type was not found during the scan. In particular, will return null for arrays that have a primitive element type.

loadElementClass

public java.lang.Class<?> loadElementClass(boolean ignoreExceptions)

Get a Class<?> reference for the array element type. Causes the ClassLoader to load the element class, if it is not already loaded.

Parameters:

ignoreExceptions - Whether or not to ignore exceptions.

Returns:

a Class<?> reference for the 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.

Overrides:

loadClass in class ClassInfo

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.

Overrides:

loadClass in class ClassInfo

Returns:

The class reference.

Throws:

java.lang.IllegalArgumentException - if there were problems loading the class.

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 in the type descriptor or type signature.

Overrides:

findReferencedClassInfo in class ClassInfo

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

equals

public boolean equals(java.lang.Object obj)

Description copied from class: ClassInfo

Use class name for equals().

Overrides:

equals in class ClassInfo

Parameters:

obj - the other object

Returns:

Whether the objects were equal.

hashCode

public int hashCode()

Description copied from class: ClassInfo

Use hash code of class name.

Overrides:

hashCode in class ClassInfo

Returns:

the hashcode

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.