ClassGraph 4.8.179 · io.github.classgraph.TypeParameter

Modifier and Type	Field and Description
pack-priv final ReferenceTypeSignature	classBound Class bound -- may be null.
pack-priv final List<ReferenceTypeSignature>	interfaceBounds Interface bounds -- may be empty.
pack-priv final String	name The type parameter identifier.

Access	Constructor and Description
protected	TypeParameter(final String The type parameter identifier. identifier, final ReferenceTypeSignature The type parameter class bound. classBound, final List<ReferenceTypeSignature> The type parameter interface bound. interfaceBounds) Constructor.

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	findReferencedClassNames(final Set<String> the referenced class names. refdClassNames) Get the names of any classes referenced in the type signature.
public ReferenceTypeSignature	Returns: The type parameter class bound. May be null. getClassBound() Get the type parameter class bound.
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 List<ReferenceTypeSignature>	Returns: Get the type parameter interface bound(s), which may be the empty list. getInterfaceBounds() Get the type parameter interface bound(s).
public String	Returns: The type parameter identifier. getName() Get the type parameter identifier.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv static List<TypeParameter>	Returns: the list of `TypeParameter` objects. parseList(final Parser the parser parser, final String the defining class name definingClassName) Parse a list of type parameters into `TypeParameter` objects.
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.HierarchicalTypeSignature:: addTypeAnnotation getTypeAnnotationInfo toString

classBound	back to summary
pack-priv final ReferenceTypeSignature classBound Class bound -- may be null.

interfaceBounds	back to summary
pack-priv final List<ReferenceTypeSignature> interfaceBounds Interface bounds -- may be empty.

name	back to summary
pack-priv final String name The type parameter identifier.

TypeParameter	back to summary
protected TypeParameter(final String identifier, final ReferenceTypeSignature classBound, final List<ReferenceTypeSignature> interfaceBounds) Constructor. Parameters identifier:String The type parameter identifier. classBound:ReferenceTypeSignature The type parameter class bound. interfaceBounds:List<ReferenceTypeSignature> The type parameter interface bound.

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

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.

getClassBound	back to summary
public ReferenceTypeSignature getClassBound() Get the type parameter class bound. Returns:ReferenceTypeSignature The type parameter class bound. May be null.

getClassBound

back to summary

public ReferenceTypeSignature getClassBound()

Get the type parameter class bound.

Returns:ReferenceTypeSignature: The type parameter class bound. May be null.

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

getInterfaceBounds	back to summary
public List<ReferenceTypeSignature> getInterfaceBounds() Get the type parameter interface bound(s). Returns:List<ReferenceTypeSignature> Get the type parameter interface bound(s), which may be the empty list.

getInterfaceBounds

back to summary

public List<ReferenceTypeSignature> getInterfaceBounds()

Get the type parameter interface bound(s).

Returns:List<ReferenceTypeSignature>: Get the type parameter interface bound(s), which may be the empty list.

getName	back to summary
public String getName() Get the type parameter identifier. Returns:String The type parameter identifier.

getName

back to summary

public String getName()

Get the type parameter identifier.

Returns:String: The type parameter identifier.

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

parseList back to summary

parseList	back to summary
pack-priv static List<TypeParameter> parseList(final Parser parser, final String definingClassName) throws ParseException Parse a list of type parameters into `TypeParameter` objects. Parameters parser:Parser the parser definingClassName:String the defining class name Returns:List<TypeParameter> the list of `TypeParameter` objects. Exceptions ParseException: if parsing fails

pack-priv static List<TypeParameter> parseList(final Parser parser, final String definingClassName) throws ParseException

Parse a list of type parameters into TypeParameter objects.

Parameters

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

Returns:List<TypeParameter>

the list of TypeParameter objects.

Exceptions

ParseException:: if parsing fails

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

public final Class TypeParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail