io.github.classgraph

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	equalsIgnoringTypeParams(TypeSignature other) Compare base types, ignoring generic type parameters.
ArrayClassInfo	getArrayClassInfo() Return an ArrayClassInfo instance for the array class, cast to its superclass.
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.
String	getTypeSignatureStr() Get the raw array type signature string, e.g.
int	hashCode()
Class<?>	loadClass() Obtain a Class<?> reference for the array class named by this ArrayClassInfo object.
Class<?>	loadClass(boolean ignoreExceptions) Obtain a Class<?> reference for the array class named by this ArrayClassInfo object.
Class<?>	loadElementClass() Get a Class<?> reference for the array element type.
Class<?>	loadElementClass(boolean ignoreExceptions) Get a Class<?> reference for the innermost array element type.
String	toString() Render to string.
String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTypeSignatureStr

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

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.

getArrayClassInfo

public ArrayClassInfo getArrayClassInfo()

Return an ArrayClassInfo instance for the array class, cast to its superclass.

Returns:

the ArrayClassInfo instance.

loadElementClass

public 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 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 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:

IllegalArgumentException - if ignoreExceptions is false and there were problems loading the class.

loadClass

public 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:

IllegalArgumentException - if there were problems loading the class.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class 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.

toStringWithSimpleNames

public String toStringWithSimpleNames()

Render to string, using only simple names for classes.

Returns:

the string representation, using simple names for classes.

toString

public String toString()

Render to string.

Overrides:

toString in class Object

Returns:

the string representation.