Class TypeParameter

java.lang.Object

io.github.classgraph.ScanResultObject

io.github.classgraph.HierarchicalTypeSignature

io.github.classgraph.TypeParameter

public final class TypeParameter
extends HierarchicalTypeSignature

A type parameter.

Field Summary

Fields

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

Fields inherited from class HierarchicalTypeSignature

typeAnnotationInfo

Fields inherited from class ScanResultObject

classRef, scanResult

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeParameter(String identifier, ReferenceTypeSignature classBound, List<ReferenceTypeSignature> interfaceBounds)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addTypeAnnotation(List<Classfile.TypePathNode> typePath, AnnotationInfo annotationInfo)	Add a type annotation.
boolean	equals(Object obj)
protected void	findReferencedClassNames(Set<String> refdClassNames)	Get the names of any classes referenced in the type signature.
ReferenceTypeSignature	getClassBound()	Get the type parameter class bound.
protected ClassInfo	getClassInfo()	Get the ClassInfo object for the referenced class, or null if the referenced class was not encountered during scanning (i.e.
protected String	getClassName()	The name of the class (used by ScanResultObject.getClassInfo() to fetch the ClassInfo object for the class).
List<ReferenceTypeSignature>	getInterfaceBounds()	Get the type parameter interface bound(s).
String	getName()	Get the type parameter identifier.
int	hashCode()
(package private) static List<TypeParameter>	parseList(Parser parser, String definingClassName)	Parse a list of type parameters into TypeParameter objects.
(package private) void	setScanResult(ScanResult scanResult)	Set ScanResult backreferences in info objects after scan has completed.
protected void	toStringInternal(boolean useSimpleNames, AnnotationInfoList annotationsToExclude, StringBuilder buf)	Render type signature to string.

Methods inherited from class HierarchicalTypeSignature

addTypeAnnotation, getTypeAnnotationInfo, toString

Methods inherited from class ScanResultObject

findReferencedClassInfo, findReferencedClassInfo, loadClass, loadClass, loadClass, loadClass, toString, toString, toStringWithSimpleNames

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

final String name

The type parameter identifier.

classBound

final ReferenceTypeSignature classBound

Class bound -- may be null.

interfaceBounds

final List<ReferenceTypeSignature> interfaceBounds

Interface bounds -- may be empty.

Constructor Details

TypeParameter

protected TypeParameter(String identifier,
 ReferenceTypeSignature classBound,
 List<ReferenceTypeSignature> interfaceBounds)

Constructor.

Parameters:

identifier - The type parameter identifier.

classBound - The type parameter class bound.

interfaceBounds - The type parameter interface bound.

Method Details

getName

public String getName()

Get the type parameter identifier.

Returns:

The type parameter identifier.

getClassBound

public ReferenceTypeSignature getClassBound()

Get the type parameter class bound.

Returns:

The type parameter class bound. May be null.

getInterfaceBounds

public List<ReferenceTypeSignature> getInterfaceBounds()

Get the type parameter interface bound(s).

Returns:

Get the type parameter interface bound(s), which may be the empty list.

addTypeAnnotation

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

Description copied from class: HierarchicalTypeSignature

Add a type annotation.

Specified by:

addTypeAnnotation in class HierarchicalTypeSignature

Parameters:

typePath - the type path

annotationInfo - the annotation

parseList

static List<TypeParameter> parseList(Parser parser,
 String definingClassName)
                              throws ParseException

Parse a list of type parameters into TypeParameter objects.

Parameters:

parser - the parser

definingClassName - the defining class name

Returns:

the list of TypeParameter objects.

Throws:

ParseException - if parsing fails

getClassName

protected String getClassName()

Description copied from class: ScanResultObject

The name of the class (used by ScanResultObject.getClassInfo() to fetch the ClassInfo object for the class).

Specified by:

getClassName in class ScanResultObject

Returns:

The class name.

getClassInfo

protected ClassInfo getClassInfo()

Description copied from class: ScanResultObject

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, ScanResultObject.loadClass() may be able to load the referenced class by name.

Overrides:

getClassInfo in class ScanResultObject

Returns:

The ClassInfo object for the referenced class.

setScanResult

void setScanResult(ScanResult scanResult)

Description copied from class: ScanResultObject

Set ScanResult backreferences in info objects after scan has completed.

Overrides:

setScanResult in class HierarchicalTypeSignature

Parameters:

scanResult - the scan result

findReferencedClassNames

protected void findReferencedClassNames(Set<String> refdClassNames)

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

Parameters:

refdClassNames - the referenced class names.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toStringInternal

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

Description copied from class: HierarchicalTypeSignature

Render type signature to string.

Specified by:

toStringInternal in class HierarchicalTypeSignature

Parameters:

useSimpleNames - whether to use simple names for classes.

annotationsToExclude - toplevel annotations to exclude, to eliminate duplication (toplevel annotations are both class/field/method annotations and type annotations).

buf - the StringBuilder to write to.