ClassGraph 4.8.179 · io.github.classgraph.TypeVariableSignature

Modifier and Type	Field and Description
pack-priv MethodTypeSignature	containingMethodSignature The method signature that this type variable is part of.
private final String	definingClassName The name of the class that this type variable is defined in.
private final String	name The type variable name.
private TypeParameter	typeParameterCached The resolved type parameter, if any.

Access	Constructor and Description
private	TypeVariableSignature(final String The type variable name. typeVariableName, final String the defining class name. definingClassName) Constructor.

Method Summary

Modifier and Type	Method 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 String	Returns: the defining class name. getClassName() Implements abstract io.github.classgraph.ScanResultObject.getClassName. Return definingClassName, so that getClassInfo() returns the `ClassInfo` object for the containing class.
public String	Returns: The type variable name. getName() Get the name of the type variable.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv static TypeVariableSignature	Returns: the type variable signature parse(final Parser the parser parser, final String the defining class name definingClassName) Hides io.github.classgraph.TypeSignature.parse. Parse a TypeVariableSignature.
public TypeParameter	Returns: the type parameter (e.g. "T extends com.xyz.Cls", or simply "T" if the type parameter does not have any bounds). resolve() Look up a type variable (e.g. "T") in the defining method and/or enclosing class' type parameters, and return the type parameter with the same name (e.g. "T extends com.xyz.Cls").
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.
public String	Returns: The string representation. toStringWithTypeBound() Returns the type variable along with its type bound, if available (e.g. "X extends xyz.Cls").

containingMethodSignature	back to summary
pack-priv MethodTypeSignature containingMethodSignature The method signature that this type variable is part of.

definingClassName	back to summary
private final String definingClassName The name of the class that this type variable is defined in.

name	back to summary
private final String name The type variable name.

typeParameterCached	back to summary
private TypeParameter typeParameterCached The resolved type parameter, if any.

TypeVariableSignature	back to summary
private TypeVariableSignature(final String typeVariableName, final String definingClassName) Constructor. Parameters typeVariableName:String The type variable name. definingClassName:String the defining class name.

Method Detail

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

getClassName back to summary

getClassName	back to summary
protected String getClassName() Implements abstract io.github.classgraph.ScanResultObject.getClassName. Return definingClassName, so that getClassInfo() returns the `ClassInfo` object for the containing class. Returns:String the defining class name. Annotations @Override

protected String getClassName()

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

Return definingClassName, so that getClassInfo() returns the ClassInfo object for the containing class.

Returns:String

the defining class name.

Annotations

@Override

getName	back to summary
public String getName() Get the name of the type variable. Returns:String The type variable name.

getName

back to summary

public String getName()

Get the name of the type variable.

Returns:String: The type variable name.

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 TypeVariableSignature parse(final Parser parser, final String definingClassName) throws ParseException Hides io.github.classgraph.TypeSignature.parse. Parse a TypeVariableSignature. Parameters parser:Parser the parser definingClassName:String the defining class name Returns:TypeVariableSignature the type variable signature Exceptions ParseException: if parsing fails

parse

back to summary

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

Hides io.github.classgraph.TypeSignature.parse.

Parse a TypeVariableSignature.

Parameters

parser:Parser: the parser
definingClassName:String: the defining class name

Returns:TypeVariableSignature

the type variable signature

Exceptions

ParseException:: if parsing fails

resolve	back to summary
public TypeParameter resolve() Look up a type variable (e.g. "T") in the defining method and/or enclosing class' type parameters, and return the type parameter with the same name (e.g. "T extends com.xyz.Cls"). Returns:TypeParameter the type parameter (e.g. "T extends com.xyz.Cls", or simply "T" if the type parameter does not have any bounds). Exceptions IllegalArgumentException: if a type parameter with the same name as the type variable could not be found in the defining method or the enclosing class.

resolve

back to summary

public TypeParameter resolve()

Look up a type variable (e.g. "T") in the defining method and/or enclosing class' type parameters, and return the type parameter with the same name (e.g. "T extends com.xyz.Cls").

Returns:TypeParameter

the type parameter (e.g. "T extends com.xyz.Cls", or simply "T" if the type parameter does not have any bounds).

Exceptions

IllegalArgumentException:: if a type parameter with the same name as the type variable could not be found in the defining method or the enclosing class.

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

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

toStringWithTypeBound back to summary

toStringWithTypeBound	back to summary
public String toStringWithTypeBound() Returns the type variable along with its type bound, if available (e.g. "X extends xyz.Cls"). You can get this in structured form by calling `resolve()`. Returns just the type variable if there is no type bound, or if no type bound is known (i.e. if `resolve()` returns null). Returns:String The string representation.

public String toStringWithTypeBound()

Returns the type variable along with its type bound, if available (e.g. "X extends xyz.Cls"). You can get this in structured form by calling resolve(). Returns just the type variable if there is no type bound, or if no type bound is known (i.e. if resolve() returns null).

Returns:String: The string representation.

public final Class TypeVariableSignature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail