ClassGraph 4.8.179 · io.github.classgraph.ClassRefTypeSignature

Modifier and Type	Field and Description
pack-priv final String	className The class name.
private final List<String>	suffixes Type suffixes.
private List<AnnotationInfoList>	suffixTypeAnnotations The suffix type annotations.
private final List<List<TypeArgument>>	suffixTypeArguments The suffix type arguments.
private final List<TypeArgument>	typeArguments The class type arguments.

Access	Constructor and Description
private	ClassRefTypeSignature(final String The class name. className, final List<TypeArgument> The class type arguments. typeArguments, final List<String> The class suffixes (for inner classes) suffixes, final List<List<TypeArgument>> The suffix type arguments. suffixTypeArguments) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	addSuffixTypeAnnotation(final int suffixIdx, final AnnotationInfo annotationInfo)
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 String	Returns: The name of the class. getBaseClassName() Get the name of the class, without any suffixes.
public ClassInfo	Returns: The `ClassInfo` object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. if 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. getClassInfo() Overrides io.github.classgraph.ScanResultObject.getClassInfo. Get the `ClassInfo` object for the referenced class.
protected String	Returns: the fully-qualified class name, for classloading. 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 String	Returns: The fully-qualified name of the class, including suffixes but without type arguments. getFullyQualifiedClassName() Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments.
public List<String>	Returns: The class suffixes (for inner classes), or the empty list if none. getSuffixes() Get all nested suffixes of the class (typically nested inner class names).
public List<AnnotationInfoList>	Returns: The list of lists of type annotations for the suffixes (nested inner classes), one list per suffix, or null if none. getSuffixTypeAnnotationInfo() Get a list of lists of type annotations for all nested suffixes of the class, one list per suffix.
public List<List<TypeArgument>>	Returns: The list of type arguments for the suffixes (nested inner classes), one list per suffix, or the empty list if none. getSuffixTypeArguments() Get a list of type arguments for all nested suffixes of the class, one list per suffix.
public List<TypeArgument>	Returns: The type arguments for the base class. getTypeArguments() Get any type arguments of the base class.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Class<?>	Returns: The `Class<?>` reference for the referenced class. loadClass(final boolean if true, ignore exceptions and instead return null if the class could not be loaded. ignoreExceptions) Overrides io.github.classgraph.ScanResultObject.loadClass. Load the referenced class, if not already loaded, returning a `Class<?`
public Class<?>	Returns: The `Class<?>` reference for the referenced class. loadClass() Overrides io.github.classgraph.ScanResultObject.loadClass. Load the referenced class, if not already loaded, returning a `Class<?`
pack-priv static ClassRefTypeSignature	Returns: The class type signature. parse(final Parser The parser. parser, final String The name of the defining class (for resolving type variables). definingClassName) Hides io.github.classgraph.TypeSignature.parse. Parse a class 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.
private static boolean	suffixesMatch(final ClassRefTypeSignature a, final ClassRefTypeSignature b)
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.

className	back to summary
pack-priv final String className The class name.

suffixes	back to summary
private final List<String> suffixes Type suffixes.

suffixTypeAnnotations	back to summary
private List<AnnotationInfoList> suffixTypeAnnotations The suffix type annotations.

suffixTypeArguments	back to summary
private final List<List<TypeArgument>> suffixTypeArguments The suffix type arguments.

typeArguments	back to summary
private final List<TypeArgument> typeArguments The class type arguments.

ClassRefTypeSignature	back to summary
private ClassRefTypeSignature(final String className, final List<TypeArgument> typeArguments, final List<String> suffixes, final List<List<TypeArgument>> suffixTypeArguments) Constructor. Parameters className:String The class name. typeArguments:List<TypeArgument> The class type arguments. suffixes:List<String> The class suffixes (for inner classes) suffixTypeArguments:List<List<TypeArgument>> The suffix type arguments.

Method Detail

addSuffixTypeAnnotation	back to summary
private void addSuffixTypeAnnotation(final int suffixIdx, final AnnotationInfo annotationInfo)

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

addTypeAnnotation

back 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

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

equalsIgnoringTypeParams back to summary

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

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

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

findReferencedClassNames

back 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

getBaseClassName back to summary

getBaseClassName	back to summary
public String getBaseClassName() Get the name of the class, without any suffixes. Returns:String The name of the class. See Also `getFullyQualifiedClassName()`

public String getBaseClassName()

Get the name of the class, without any suffixes.

Returns:String: The name of the class.
See Also: getFullyQualifiedClassName()

getClassInfo back to summary

getClassInfo	back to summary
public ClassInfo getClassInfo() Overrides io.github.classgraph.ScanResultObject.getClassInfo. Get the `ClassInfo` object for the referenced class. Returns:ClassInfo The `ClassInfo` object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. if 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. Annotations @Override

public ClassInfo getClassInfo()

Overrides io.github.classgraph.ScanResultObject.getClassInfo.

Get the ClassInfo object for the referenced class.

Returns:ClassInfo

The ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e. if 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.

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 fully-qualified class name, for classloading. 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 fully-qualified class name, for classloading.

Annotations

@Override

getFullyQualifiedClassName back to summary

getFullyQualifiedClassName	back to summary
public String getFullyQualifiedClassName() Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments. For example, `"xyz.Cls<String>.InnerCls<Integer>"` is returned as `"xyz.Cls$InnerCls"`. The intent of this method is that if you replace '.' with '/', and then add the suffix ".class", you end up with the path of the classfile relative to the package root. For comparison, `toString()` uses '.' to separate suffixes, and includes type parameters, whereas this method uses '$' to separate suffixes, and does not include type parameters. Returns:String The fully-qualified name of the class, including suffixes but without type arguments.

public String getFullyQualifiedClassName()

Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments. For example, "xyz.Cls<String>.InnerCls<Integer>" is returned as "xyz.Cls$InnerCls". The intent of this method is that if you replace '.' with '/', and then add the suffix ".class", you end up with the path of the classfile relative to the package root.

For comparison, toString() uses '.' to separate suffixes, and includes type parameters, whereas this method uses '$' to separate suffixes, and does not include type parameters.

Returns:String: The fully-qualified name of the class, including suffixes but without type arguments.

getSuffixes	back to summary
public List<String> getSuffixes() Get all nested suffixes of the class (typically nested inner class names). Returns:List<String> The class suffixes (for inner classes), or the empty list if none.

getSuffixes

back to summary

public List<String> getSuffixes()

Get all nested suffixes of the class (typically nested inner class names).

Returns:List<String>: The class suffixes (for inner classes), or the empty list if none.

getSuffixTypeAnnotationInfo	back to summary
public List<AnnotationInfoList> getSuffixTypeAnnotationInfo() Get a list of lists of type annotations for all nested suffixes of the class, one list per suffix. Returns:List<AnnotationInfoList> The list of lists of type annotations for the suffixes (nested inner classes), one list per suffix, or null if none.

getSuffixTypeAnnotationInfo

back to summary

public List<AnnotationInfoList> getSuffixTypeAnnotationInfo()

Get a list of lists of type annotations for all nested suffixes of the class, one list per suffix.

Returns:List<AnnotationInfoList>: The list of lists of type annotations for the suffixes (nested inner classes), one list per suffix, or null if none.

getSuffixTypeArguments	back to summary
public List<List<TypeArgument>> getSuffixTypeArguments() Get a list of type arguments for all nested suffixes of the class, one list per suffix. Returns:List<List<TypeArgument>> The list of type arguments for the suffixes (nested inner classes), one list per suffix, or the empty list if none.

getSuffixTypeArguments

back to summary

public List<List<TypeArgument>> getSuffixTypeArguments()

Get a list of type arguments for all nested suffixes of the class, one list per suffix.

Returns:List<List<TypeArgument>>: The list of type arguments for the suffixes (nested inner classes), one list per suffix, or the empty list if none.

getTypeArguments	back to summary
public List<TypeArgument> getTypeArguments() Get any type arguments of the base class. Returns:List<TypeArgument> The type arguments for the base class.

getTypeArguments

back to summary

public List<TypeArgument> getTypeArguments()

Get any type arguments of the base class.

Returns:List<TypeArgument>: The type arguments for the base 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

loadClass back to summary

loadClass	back to summary
public Class<?> loadClass(final boolean ignoreExceptions) Overrides io.github.classgraph.ScanResultObject.loadClass. Load the referenced class, if not already loaded, returning a `Class<?>` reference for the referenced class. (Called by `AnnotationClassRef#loadClass()`.) Parameters ignoreExceptions:boolean if true, ignore exceptions and instead return null if the class could not be loaded. Returns:Class<?> The `Class<?>` reference for the referenced class. Annotations @Override Exceptions IllegalArgumentException: if the class could not be loaded and ignoreExceptions was false.

public Class<?> loadClass(final boolean ignoreExceptions)

Overrides io.github.classgraph.ScanResultObject.loadClass.

Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class. (Called by AnnotationClassRef#loadClass().)

Parameters

ignoreExceptions:boolean: if true, ignore exceptions and instead return null if the class could not be loaded.

Returns:Class<?>

The Class<?> reference for the referenced class.

Annotations

@Override

Exceptions

IllegalArgumentException:: if the class could not be loaded and ignoreExceptions was false.

loadClass back to summary

loadClass	back to summary
public Class<?> loadClass() Overrides io.github.classgraph.ScanResultObject.loadClass. Load the referenced class, if not already loaded, returning a `Class<?>` reference for the referenced class. (Called by `AnnotationClassRef#loadClass()`.) Returns:Class<?> The `Class<?>` reference for the referenced class. Annotations @Override Exceptions IllegalArgumentException: if the class could not be loaded.

public Class<?> loadClass()

Overrides io.github.classgraph.ScanResultObject.loadClass.

Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class. (Called by AnnotationClassRef#loadClass().)

Returns:Class<?>

The Class<?> reference for the referenced class.

Annotations

@Override

Exceptions

IllegalArgumentException:: if the class could not be loaded.

parse	back to summary
pack-priv static ClassRefTypeSignature parse(final Parser parser, final String definingClassName) throws ParseException Hides io.github.classgraph.TypeSignature.parse. Parse a class type signature. Parameters parser:Parser The parser. definingClassName:String The name of the defining class (for resolving type variables). Returns:ClassRefTypeSignature The class type signature. Exceptions ParseException: If the type signature could not be parsed.

parse

back to summary

pack-priv static ClassRefTypeSignature parse(final Parser parser, final String definingClassName) throws ParseException

Hides io.github.classgraph.TypeSignature.parse.

Parse a class type signature.

Parameters

parser:Parser: The parser.
definingClassName:String: The name of the defining class (for resolving type variables).

Returns:ClassRefTypeSignature

The class type signature.

Exceptions

ParseException:: If the 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

suffixesMatch	back to summary
private static boolean suffixesMatch(final ClassRefTypeSignature a, final ClassRefTypeSignature b)

toStringInternal back to summary

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

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

public final Class ClassRefTypeSignature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail