ClassGraph 4.8.179 · io.github.classgraph.ClassTypeSignature

Modifier and Type	Field and Description
private final ClassInfo	classInfo Hides io.github.classgraph.ScanResultObject.classInfo. The class info.
private final ClassRefTypeSignature	superclassSignature The superclass type.
private final List<ClassRefTypeSignature>	superinterfaceSignatures The superinterface signatures.
private final List<ClassRefOrTypeVariableSignature>	throwsSignatures The throws signatures (usually null).
pack-priv final List<TypeParameter>	typeParameters The class type parameters.

Access	Constructor and Description
private	ClassTypeSignature(final ClassInfo the `ClassInfo` object of the class. classInfo, final List<TypeParameter> The class type parameters. typeParameters, final ClassRefTypeSignature The superclass signature. superclassSignature, final List<ClassRefTypeSignature> The superinterface signature(s). superinterfaceSignatures, final List<ClassRefOrTypeVariableSignature> the throws signatures (these are actually invalid, but can be added by Scala: #495). Usually null. throwsSignatures) Constructor.
pack-priv	ClassTypeSignature(final ClassInfo The class. classInfo, final ClassInfo The superclass. superclass, final ClassInfoList The implemented interfaces. interfaces) Constructor used to create synthetic class type descriptor (#662).

Method Summary

Modifier and Type	Method and Description
protected void	addTypeAnnotation(final List<Classfile.TypePathNode> the type path typePath, final AnnotationInfo the annotation annotationInfo) Implements abstract io.github.classgraph.HierarchicalTypeSignature.addTypeAnnotation. Add a type annotation.
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.
protected void	findReferencedClassInfo(final Map<String, ClassInfo> the map from class name to `ClassInfo`. classNameToClassInfo, final Set<ClassInfo> the referenced class info refdClassInfo, final LogNode the log log) Overrides io.github.classgraph.ScanResultObject.findReferencedClassInfo. Get `ClassInfo` objects for any classes referenced in the type descriptor or type signature.
protected void	findReferencedClassNames(final Set<String> the referenced class names. refdClassNames) 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).
public ClassRefTypeSignature	Returns: The type signature for the superclass, or null if no superclass (i.e. for `java.lang.Object`). getSuperclassSignature() Get the type signature for the superclass (possibly null in the case of `java.lang.Object`, since it doesn't have a superclass).
public List<ClassRefTypeSignature>	Returns: The type signatures of any superinterfaces. getSuperinterfaceSignatures() Get the type signatures of any superinterfaces.
pack-priv List<ClassRefOrTypeVariableSignature>	Returns: the throws signatures getThrowsSignatures() Gets the throws signatures.
public List<TypeParameter>	Returns: The type parameters for the class. getTypeParameters() Get the type parameters for the class.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv static ClassTypeSignature	Returns: The parsed class type signature or class type descriptor. parse(final String The class type signature or class type descriptor to parse. typeDescriptor, final ClassInfo the class info classInfo) Parse a class type signature or class type descriptor.
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.
pack-priv void	toStringInternal(final String The class name className, final boolean the use simple names useSimpleNames, final int The class modifiers. modifiers, final boolean True if the class is an annotation. isAnnotation, final boolean True if the class is an interface. isInterface, final AnnotationInfoList the annotations to exclude annotationsToExclude, final StringBuilder the buf buf) Render into String form.
protected void	toStringInternal(final boolean the use simple names useSimpleNames, final AnnotationInfoList the annotations to exclude annotationsToExclude, final StringBuilder the buf buf) Implements abstract io.github.classgraph.HierarchicalTypeSignature.toStringInternal. To string internal.

Inherited from io.github.classgraph.HierarchicalTypeSignature:: addTypeAnnotation getTypeAnnotationInfo toString

classInfo	back to summary
private final ClassInfo classInfo Hides io.github.classgraph.ScanResultObject.classInfo. The class info.

superclassSignature	back to summary
private final ClassRefTypeSignature superclassSignature The superclass type.

superinterfaceSignatures	back to summary
private final List<ClassRefTypeSignature> superinterfaceSignatures The superinterface signatures.

throwsSignatures	back to summary
private final List<ClassRefOrTypeVariableSignature> throwsSignatures The throws signatures (usually null). These are only present in Scala classes, if the class is marked up with `@throws`, and they violate the classfile spec (#495), but we parse them anyway.

typeParameters	back to summary
pack-priv final List<TypeParameter> typeParameters The class type parameters.

ClassTypeSignature	back to summary
private ClassTypeSignature(final ClassInfo classInfo, final List<TypeParameter> typeParameters, final ClassRefTypeSignature superclassSignature, final List<ClassRefTypeSignature> superinterfaceSignatures, final List<ClassRefOrTypeVariableSignature> throwsSignatures) Constructor. Parameters classInfo:ClassInfo the `ClassInfo` object of the class. typeParameters:List<TypeParameter> The class type parameters. superclassSignature:ClassRefTypeSignature The superclass signature. superinterfaceSignatures:List<ClassRefTypeSignature> The superinterface signature(s). throwsSignatures:List<ClassRefOrTypeVariableSignature> the throws signatures (these are actually invalid, but can be added by Scala: #495). Usually null.

ClassTypeSignature	back to summary
pack-priv ClassTypeSignature(final ClassInfo classInfo, final ClassInfo superclass, final ClassInfoList interfaces) Constructor used to create synthetic class type descriptor (#662). Parameters classInfo:ClassInfo The class. superclass:ClassInfo The superclass. interfaces:ClassInfoList The implemented interfaces.

Method Detail

addTypeAnnotation	back to summary
protected void addTypeAnnotation(final List<Classfile.TypePathNode> typePath, final AnnotationInfo annotationInfo) Implements abstract io.github.classgraph.HierarchicalTypeSignature.addTypeAnnotation. Doc from io.github.classgraph.HierarchicalTypeSignature.addTypeAnnotation. Add a type annotation. Parameters typePath:List<Classfile.TypePathNode> the type path annotationInfo:AnnotationInfo the annotation Annotations @Override

addTypeAnnotation

back to summary

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

Implements abstract io.github.classgraph.HierarchicalTypeSignature.addTypeAnnotation.

Doc from io.github.classgraph.HierarchicalTypeSignature.addTypeAnnotation.

Add a type annotation.

Parameters

typePath:List<Classfile.TypePathNode>: the type path
annotationInfo:AnnotationInfo: the annotation

Annotations

@Override

equals back to summary

equals	back 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

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

findReferencedClassInfo back to summary

findReferencedClassInfo	back to summary
protected void findReferencedClassInfo(final Map<String, ClassInfo> classNameToClassInfo, final Set<ClassInfo> refdClassInfo, final LogNode log) Overrides io.github.classgraph.ScanResultObject.findReferencedClassInfo. Get `ClassInfo` objects for any classes referenced in the type descriptor or type signature. Parameters classNameToClassInfo:Map<String, ClassInfo> the map from class name to `ClassInfo`. refdClassInfo:Set<ClassInfo> the referenced class info log:LogNode Doc from io.github.classgraph.ScanResultObject.findReferencedClassInfo. the log Annotations @Override

protected void findReferencedClassInfo(final Map<String, ClassInfo> classNameToClassInfo, final Set<ClassInfo> refdClassInfo, final LogNode log)

Overrides io.github.classgraph.ScanResultObject.findReferencedClassInfo.

Get ClassInfo objects for any classes referenced in the type descriptor or type signature.

Parameters

classNameToClassInfo:Map<String, ClassInfo>

the map from class name to ClassInfo.

refdClassInfo:Set<ClassInfo>

the referenced class info

log:LogNode

Doc from io.github.classgraph.ScanResultObject.findReferencedClassInfo.

the log

Annotations

@Override

findReferencedClassNames	back to summary
protected void findReferencedClassNames(final Set<String> refdClassNames) Get the names of any classes referenced in the type signature. Parameters refdClassNames:Set<String> the referenced class names.

findReferencedClassNames

back to summary

protected void findReferencedClassNames(final Set<String> refdClassNames)

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

Parameters

refdClassNames:Set<String>: the referenced class names.

getClassInfo back to summary

getClassInfo	back 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

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

getClassName back to summary

getClassName	back 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

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

getSuperclassSignature back to summary

getSuperclassSignature	back to summary
public ClassRefTypeSignature getSuperclassSignature() Get the type signature for the superclass (possibly null in the case of `java.lang.Object`, since it doesn't have a superclass). Returns:ClassRefTypeSignature The type signature for the superclass, or null if no superclass (i.e. for `java.lang.Object`).

public ClassRefTypeSignature getSuperclassSignature()

Get the type signature for the superclass (possibly null in the case of java.lang.Object, since it doesn't have a superclass).

Returns:ClassRefTypeSignature: The type signature for the superclass, or null if no superclass (i.e. for java.lang.Object).

getSuperinterfaceSignatures	back to summary
public List<ClassRefTypeSignature> getSuperinterfaceSignatures() Get the type signatures of any superinterfaces. Returns:List<ClassRefTypeSignature> The type signatures of any superinterfaces.

getSuperinterfaceSignatures

back to summary

public List<ClassRefTypeSignature> getSuperinterfaceSignatures()

Get the type signatures of any superinterfaces.

Returns:List<ClassRefTypeSignature>: The type signatures of any superinterfaces.

getThrowsSignatures	back to summary
pack-priv List<ClassRefOrTypeVariableSignature> getThrowsSignatures() Gets the throws signatures. These are invalid according to the classfile spec (so this method is currently non-public), but may be added by the Scala compiler. (See bug #495.) Returns:List<ClassRefOrTypeVariableSignature> the throws signatures

getThrowsSignatures

back to summary

pack-priv List<ClassRefOrTypeVariableSignature> getThrowsSignatures()

Gets the throws signatures. These are invalid according to the classfile spec (so this method is currently non-public), but may be added by the Scala compiler. (See bug #495.)

Returns:List<ClassRefOrTypeVariableSignature>: the throws signatures

getTypeParameters	back to summary
public List<TypeParameter> getTypeParameters() Get the type parameters for the class. Returns:List<TypeParameter> The type parameters for the class.

getTypeParameters

back to summary

public List<TypeParameter> getTypeParameters()

Get the type parameters for the class.

Returns:List<TypeParameter>: The type parameters for the class.

hashCode back to summary

hashCode	back 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

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

parse	back to summary
pack-priv static ClassTypeSignature parse(final String typeDescriptor, final ClassInfo classInfo) throws ParseException Parse a class type signature or class type descriptor. Parameters typeDescriptor:String The class type signature or class type descriptor to parse. classInfo:ClassInfo the class info Returns:ClassTypeSignature The parsed class type signature or class type descriptor. Exceptions ParseException: If the class type signature could not be parsed.

parse

back to summary

pack-priv static ClassTypeSignature parse(final String typeDescriptor, final ClassInfo classInfo) throws ParseException

Parse a class type signature or class type descriptor.

Parameters

typeDescriptor:String: The class type signature or class type descriptor to parse.
classInfo:ClassInfo: the class info

Returns:ClassTypeSignature

The parsed class type signature or class type descriptor.

Exceptions

ParseException:: If the class type signature could not be parsed.

setScanResult	back 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

setScanResult

back 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

toStringInternal	back to summary
pack-priv void toStringInternal(final String className, final boolean useSimpleNames, final int modifiers, final boolean isAnnotation, final boolean isInterface, final AnnotationInfoList annotationsToExclude, final StringBuilder buf) Render into String form. Parameters className:String The class name useSimpleNames:boolean the use simple names modifiers:int The class modifiers. isAnnotation:boolean True if the class is an annotation. isInterface:boolean True if the class is an interface. annotationsToExclude:AnnotationInfoList the annotations to exclude buf:StringBuilder the buf

toStringInternal

back to summary

pack-priv void toStringInternal(final String className, final boolean useSimpleNames, final int modifiers, final boolean isAnnotation, final boolean isInterface, final AnnotationInfoList annotationsToExclude, final StringBuilder buf)

Render into String form.

Parameters

className:String: The class name
useSimpleNames:boolean: the use simple names
modifiers:int: The class modifiers.
isAnnotation:boolean: True if the class is an annotation.
isInterface:boolean: True if the class is an interface.
annotationsToExclude:AnnotationInfoList: the annotations to exclude
buf:StringBuilder: the buf

toStringInternal	back to summary
protected void toStringInternal(final boolean useSimpleNames, final AnnotationInfoList annotationsToExclude, final StringBuilder buf) Implements abstract io.github.classgraph.HierarchicalTypeSignature.toStringInternal. To string internal. Parameters useSimpleNames:boolean the use simple names annotationsToExclude:AnnotationInfoList the annotations to exclude buf:StringBuilder the buf Annotations @Override

toStringInternal

back to summary

protected void toStringInternal(final boolean useSimpleNames, final AnnotationInfoList annotationsToExclude, final StringBuilder buf)

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

To string internal.

Parameters

useSimpleNames:boolean: the use simple names
annotationsToExclude:AnnotationInfoList: the annotations to exclude
buf:StringBuilder: the buf

Annotations

@Override

public final Class ClassTypeSignature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail