Top Description Fields Constructors Methods
io.github.classgraph

public Class ArrayTypeSignature

extends ReferenceTypeSignature
Class Inheritance
Imports
java.lang.reflect.Array, java.util.List, .Objects, .Set, io.github.classgraph.Classfile.TypePathNode, nonapi.io.github.classgraph.types.ParseException, .Parser
An array type signature.

Field Summary

Modifier and TypeField and Description
private ArrayClassInfo
arrayClassInfo

Array class info.

private String
className

Human-readable class name, e.g. "java.lang.String[]".

private Class<?>
elementClassRef

The element class.

private final TypeSignature
nestedType

The nested type (another ArrayTypeSignature, or the base element type).

private final String
typeSignatureStr

The raw type signature string for the array type.

Constructor Summary

AccessConstructor and Description
pack-priv
ArrayTypeSignature(final TypeSignature
The type signature of the array elements.
elementTypeSignature, final int
The number of array dimensions.
numDims, final String
Raw array type signature string (e.g. "[[I")
typeSignatureStr)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected void
addTypeAnnotation(final List<Classfile.TypePathNode>
The type path.
typePath, final AnnotationInfo
The annotation to add.
annotationInfo)

Implements abstract io.github.classgraph.TypeSignature.addTypeAnnotation.

Add a type annotation to this type.

public boolean
equals(final Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public boolean
equalsIgnoringTypeParams(final TypeSignature
the other TypeSignature to compare to.
other)

Implements abstract io.github.classgraph.TypeSignature.equalsIgnoringTypeParams.

Compare base types, ignoring generic type parameters.

protected void
findReferencedClassNames(final Set<String>
the referenced class names.
refdClassNames)

Overrides io.github.classgraph.TypeSignature.findReferencedClassNames.

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

public ArrayClassInfo

Returns:

the ArrayClassInfo instance.
getArrayClassInfo()

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

protected ClassInfo
getClassInfo()

Overrides io.github.classgraph.ScanResultObject.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 String
getClassName()

Implements abstract io.github.classgraph.ScanResultObject.getClassName.

The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).

public TypeSignature

Returns:

The type signature of the innermost element type.
getElementTypeSignature()

Get the type signature of the innermost element type of the array.

public TypeSignature

Returns:

The nested type.
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.

public int

Returns:

The number of dimensions of the array.
getNumDimensions()

Get the number of dimensions of the array.

public AnnotationInfoList

Returns:

a list of AnnotationInfo objects for the type annotations of on this array type, or null if none.
getTypeAnnotationInfo()

Overrides io.github.classgraph.TypeSignature.getTypeAnnotationInfo.

Get a list of AnnotationInfo objects for the type annotations on this array type, or null if none.

public String

Returns:

the raw array type signature string.
getTypeSignatureStr()

Get the raw array type signature string, e.g. "[[I".

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Class<?>

Returns:

The class reference, or null, if ignoreExceptions is true and there was an exception or error loading the class.
loadClass(final boolean
Whether or not to ignore exceptions.
ignoreExceptions)

Overrides io.github.classgraph.ScanResultObject.loadClass.

Obtain a Class<?

public Class<?>

Returns:

The class reference.
loadClass()

Overrides io.github.classgraph.ScanResultObject.loadClass.

Obtain a Class<?

public Class<?>

Returns:

a Class<?> reference for the innermost array element type. Also works for arrays of primitive element type.
loadElementClass(final boolean
Whether or not to ignore exceptions.
ignoreExceptions)

Get a Class<?

public Class<?>

Returns:

a Class<?> reference for the array element type. Also works for arrays of primitive element type.
loadElementClass()

Get a Class<?

pack-priv static ArrayTypeSignature

Returns:

the array type signature
parse(final Parser
the parser
parser, final String
the defining class name
definingClassName)

Hides io.github.classgraph.TypeSignature.parse.

Parses the array type signature.

pack-priv void
setScanResult(final ScanResult
the scan result
scanResult)

Overrides io.github.classgraph.HierarchicalTypeSignature.setScanResult.

Set ScanResult backreferences in info objects after scan has completed.

protected void
toStringInternal(final boolean
whether to use simple names for classes.
useSimpleNames, final AnnotationInfoList
toplevel annotations to exclude, to eliminate duplication (toplevel annotations are both class/field/method annotations and type annotations).
annotationsToExclude, final StringBuilder
the StringBuilder to write to.
buf)

Implements abstract io.github.classgraph.HierarchicalTypeSignature.toStringInternal.

Render type signature to string.

Inherited from io.github.classgraph.ReferenceTypeSignature:
parseClassBoundparseReferenceTypeSignature

Field Detail

arrayClassInfoback to summary
private ArrayClassInfo arrayClassInfo

Array class info.

classNameback to summary
private String className

Human-readable class name, e.g. "java.lang.String[]".

elementClassRefback to summary
private Class<?> elementClassRef

The element class.

nestedTypeback to summary
private final TypeSignature nestedType

The nested type (another ArrayTypeSignature, or the base element type).

typeSignatureStrback to summary
private final String typeSignatureStr

The raw type signature string for the array type.

Constructor Detail

ArrayTypeSignatureback to summary
pack-priv ArrayTypeSignature(final TypeSignature elementTypeSignature, final int numDims, final String typeSignatureStr)

Constructor.

Parameters
elementTypeSignature:TypeSignature

The type signature of the array elements.

numDims:int

The number of array dimensions.

typeSignatureStr:String

Raw array type signature string (e.g. "[[I")

Method Detail

addTypeAnnotationback to summary
protected void addTypeAnnotation(final List<Classfile.TypePathNode> typePath, final AnnotationInfo annotationInfo)

Implements abstract io.github.classgraph.TypeSignature.addTypeAnnotation.

Doc from io.github.classgraph.TypeSignature.addTypeAnnotation.

Add a type annotation to this type.

Parameters
typePath:List<Classfile.TypePathNode>

The type path.

annotationInfo:AnnotationInfo

The annotation to add.

Annotations
@Override
equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
equalsIgnoringTypeParamsback to summary
public boolean equalsIgnoringTypeParams(final TypeSignature other)

Implements abstract io.github.classgraph.TypeSignature.equalsIgnoringTypeParams.

Doc from io.github.classgraph.TypeSignature.equalsIgnoringTypeParams.

Compare base types, ignoring generic type parameters.

Parameters
other:TypeSignature

the other TypeSignature to compare to.

Returns:boolean

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

Annotations
@Override
findReferencedClassNamesback to summary
protected void findReferencedClassNames(final Set<String> refdClassNames)

Overrides io.github.classgraph.TypeSignature.findReferencedClassNames.

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

Parameters
refdClassNames:Set<String>

the referenced class names.

Annotations
@Override
getArrayClassInfoback to summary
public ArrayClassInfo getArrayClassInfo()

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

Returns:ArrayClassInfo

the ArrayClassInfo instance.

getClassInfoback to summary
protected ClassInfo getClassInfo()

Overrides io.github.classgraph.ScanResultObject.getClassInfo.

Doc from io.github.classgraph.ScanResultObject.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:ClassInfo

The ClassInfo object for the referenced class.

Annotations
@Override
getClassNameback to summary
protected String getClassName()

Implements abstract io.github.classgraph.ScanResultObject.getClassName.

Doc from io.github.classgraph.ScanResultObject.getClassName.

The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).

Returns:String

The class name.

Annotations
@Override
getElementTypeSignatureback to summary
public TypeSignature getElementTypeSignature()

Get the type signature of the innermost element type of the array.

Returns:TypeSignature

The type signature of the innermost element type.

getNestedTypeback to summary
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:TypeSignature

The nested type.

getNumDimensionsback to summary
public int getNumDimensions()

Get the number of dimensions of the array.

Returns:int

The number of dimensions of the array.

getTypeAnnotationInfoback to summary
public AnnotationInfoList getTypeAnnotationInfo()

Overrides io.github.classgraph.TypeSignature.getTypeAnnotationInfo.

Get a list of AnnotationInfo objects for the type annotations on this array type, or null if none.

Returns:AnnotationInfoList

a list of AnnotationInfo objects for the type annotations of on this array type, or null if none.

Annotations
@Override
See Also
if you want to read for type annotations on inner (nested) dimensions of the array type.
getTypeSignatureStrback to summary
public String getTypeSignatureStr()

Get the raw array type signature string, e.g. "[[I".

Returns:String

the raw array type signature string.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
loadClassback to summary
public Class<?> loadClass(final boolean ignoreExceptions)

Overrides io.github.classgraph.ScanResultObject.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.

Parameters
ignoreExceptions:boolean

Whether or not to ignore exceptions.

Returns:Class<?>

The class reference, or null, if ignoreExceptions is true and there was an exception or error loading the class.

Annotations
@Override
Exceptions
IllegalArgumentException:
if ignoreExceptions is false and there were problems loading the class.
loadClassback to summary
public Class<?> loadClass()

Overrides io.github.classgraph.ScanResultObject.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:Class<?>

The class reference.

Annotations
@Override
Exceptions
IllegalArgumentException:
if there were problems loading the class.
loadElementClassback to summary
public Class<?> loadElementClass(final 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:boolean

Whether or not to ignore exceptions.

Returns:Class<?>

a Class<?> reference for the innermost array element type. Also works for arrays of primitive element type.

loadElementClassback to summary
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:Class<?>

a Class<?> reference for the array element type. Also works for arrays of primitive element type.

parseback to summary
pack-priv static ArrayTypeSignature parse(final Parser parser, final String definingClassName) throws ParseException

Hides io.github.classgraph.TypeSignature.parse.

Parses the array type signature.

Parameters
parser:Parser

the parser

definingClassName:String

the defining class name

Returns:ArrayTypeSignature

the array type signature

Exceptions
ParseException:
if parsing fails
setScanResultback to summary
pack-priv void setScanResult(final ScanResult scanResult)

Overrides io.github.classgraph.HierarchicalTypeSignature.setScanResult.

Doc from io.github.classgraph.ScanResultObject.setScanResult.

Set ScanResult backreferences in info objects after scan has completed.

Parameters
scanResult:ScanResult

the scan result

Annotations
@Override
toStringInternalback to summary
protected void toStringInternal(final boolean useSimpleNames, final AnnotationInfoList annotationsToExclude, final StringBuilder buf)

Implements abstract io.github.classgraph.HierarchicalTypeSignature.toStringInternal.

Doc from io.github.classgraph.HierarchicalTypeSignature.toStringInternal.

Render type signature to string.

Parameters
useSimpleNames:boolean

whether to use simple names for classes.

annotationsToExclude:AnnotationInfoList

toplevel annotations to exclude, to eliminate duplication (toplevel annotations are both class/field/method annotations and type annotations).

buf:StringBuilder

the StringBuilder to write to.

Annotations
@Override