Top Description Fields Constructors Methods
io.github.classgraph

public Class BaseTypeSignature

extends TypeSignature
Class Inheritance
Imports
java.util.List, .Objects, .Set, io.github.classgraph.Classfile.TypePathNode, nonapi.io.github.classgraph.types.Parser
A type signature for a base type (byte, char, double, float, int, long, short, boolean, or void).

Field Summary

Modifier and TypeField and Description
private final char
typeSignatureChar

The type signature character used to represent the base type.

Constructor Summary

AccessConstructor and Description
pack-priv
BaseTypeSignature(final char typeSignatureChar)

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.

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

pack-priv static Class<?>

Returns:

The type class, e.g. int.class, or null if there was no match.
getType(final char
the type character, e.g. 'I'.
typeChar)

Get the type for a type character.

public Class<?>

Returns:

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

Get the type.

pack-priv static char

Returns:

The type, character, e.g. 'I', or '\0' if there was no match.
getTypeChar(final String
the type character, e.g. "int".
typeStr)

Get the name of the type as a string.

public char

Returns:

the type signature char, as a one-char String.
getTypeSignatureChar()

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

pack-priv static String

Returns:

The name of the type, e.g. "int", or null if there was no match.
getTypeStr(final char
the type character, e.g. 'I'.
typeChar)

Get the name of the type as a string.

public String

Returns:

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

Get the name of the type as a string.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

pack-priv Class<?>
loadClass()

Overrides io.github.classgraph.ScanResultObject.loadClass.

Load the class named returned by getClassInfo(), or if that returns null, the class named by getClassName().

pack-priv <T> Class<T>
loadClass(final Class<T>
The type to cast the resulting class reference to.
superclassOrInterfaceType)

Overrides io.github.classgraph.ScanResultObject.loadClass.

Load the class named returned by getClassInfo(), or if that returns null, the class named by getClassName().

pack-priv static BaseTypeSignature

Returns:

the base type signature
parse(final Parser
the parser
parser)

Parse a base type.

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.TypeSignature:
findReferencedClassInfogetTypeAnnotationInfoparseparse

Field Detail

typeSignatureCharback to summary
private final char typeSignatureChar

The type signature character used to represent the base type.

Constructor Detail

BaseTypeSignatureback to summary
pack-priv BaseTypeSignature(final char typeSignatureChar)

Constructor.

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
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
getTypeback to summary
pack-priv static Class<?> getType(final char typeChar)

Get the type for a type character.

Parameters
typeChar:char

the type character, e.g. 'I'.

Returns:Class<?>

The type class, e.g. int.class, or null if there was no match.

getTypeback to summary
public Class<?> getType()

Get the type.

Returns:Class<?>

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

getTypeCharback to summary
pack-priv static char getTypeChar(final String typeStr)

Get the name of the type as a string.

Parameters
typeStr:String

the type character, e.g. "int".

Returns:char

The type, character, e.g. 'I', or '\0' if there was no match.

getTypeSignatureCharback to summary
public char getTypeSignatureChar()

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

Returns:char

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

getTypeStrback to summary
pack-priv static String getTypeStr(final char typeChar)

Get the name of the type as a string.

Parameters
typeChar:char

the type character, e.g. 'I'.

Returns:String

The name of the type, e.g. "int", or null if there was no match.

getTypeStrback to summary
public String getTypeStr()

Get the name of the type as a string.

Returns:String

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

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
pack-priv Class<?> loadClass()

Overrides io.github.classgraph.ScanResultObject.loadClass.

Doc from io.github.classgraph.ScanResultObject.loadClass.

Load the class named returned by getClassInfo(), or if that returns null, the class named by getClassName(). Returns a Class<?> reference for the class.

Returns:Class<?>

The Class<?> reference for the referenced class.

Annotations
@Override
loadClassback to summary
pack-priv <T> Class<T> loadClass(final Class<T> superclassOrInterfaceType)

Overrides io.github.classgraph.ScanResultObject.loadClass.

Doc from io.github.classgraph.ScanResultObject.loadClass.

Load the class named returned by getClassInfo(), or if that returns null, the class named by getClassName(). Returns a Class<?> reference for the class, cast to the requested superclass or interface type.

Parameters
<T>
the superclass or interface type
superclassOrInterfaceType:Class<T>

The type to cast the resulting class reference to.

Returns:Class<T>

The Class<?> reference for the referenced class, or null if the class could not be loaded (or casting failed) and ignoreExceptions is true.

Annotations
@Override
parseback to summary
pack-priv static BaseTypeSignature parse(final Parser parser)

Parse a base type.

Parameters
parser:Parser

the parser

Returns:BaseTypeSignature

the base type signature

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