io.github.classgraph

Class BaseTypeSignature

java.lang.Object

io.github.classgraph.HierarchicalTypeSignature

io.github.classgraph.TypeSignature

io.github.classgraph.BaseTypeSignature

public class BaseTypeSignature
extends TypeSignature

A type signature for a base type (byte, char, double, float, int, long, short, boolean, or void).

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

Method Summary

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.
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).
java.lang.Class<?>	getType() Get the type.
char	getTypeSignatureChar() Get the type signature char used to represent the type, e.g.
java.lang.String	getTypeStr() Get the name of the type as a string.
int	hashCode()
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

getTypeSignatureChar

public char getTypeSignatureChar()

Get the type signature char used to represent the type, e.g. 'I' for int.

Returns:

the type signature char, as a one-char String.

getTypeStr

public java.lang.String getTypeStr()

Get the name of the type as a string.

Returns:

The name of the type, such as "int", "float", or "void".

getType

public java.lang.Class<?> getType()

Get the type.

Returns:

The class of the base type, such as int.class, float.class, or void.class.

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.

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.

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.