io.github.classgraph

Class AnnotationClassRef

java.lang.Object

io.github.classgraph.AnnotationClassRef

public class AnnotationClassRef
extends java.lang.Object

Stores the type descriptor of a Class<?>, as found in an annotation parameter value.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<?>	classRef The class ref, once the class is loaded.
protected ScanResult	scanResult The scan result.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected void	findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log) Get ClassInfo objects for any classes referenced by this object.
ClassInfo	getClassInfo() Get the class info.
protected java.lang.String	getClassName() The name of the class (used by getClassInfo() to fetch the ClassInfo object for the class).
java.lang.String	getName() Get the name of the referenced class.
int	hashCode()
java.lang.Class<?>	loadClass() Loads the referenced class, returning a {@code Class
java.lang.Class<?>	loadClass(boolean ignoreExceptions) Loads the referenced class, returning a {@code Class
java.lang.String	toString() Render to string.
protected void	toString(boolean useSimpleNames, java.lang.StringBuilder buf) Render to string.
java.lang.String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class java.lang.Object

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

Field Detail

scanResult

protected transient ScanResult scanResult

The scan result.

classRef

protected transient java.lang.Class<?> classRef

The class ref, once the class is loaded.

Method Detail

getName

public java.lang.String getName()

Get the name of the referenced class.

Returns:

The name of the referenced class.

loadClass

public java.lang.Class<?> loadClass(boolean ignoreExceptions)

Loads the referenced class, returning a Class<?> reference for the referenced class.

Parameters:

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

Returns:

The Class<?> reference for the referenced class.

Throws:

java.lang.IllegalArgumentException - if the class could not be loaded and ignoreExceptions was false.

loadClass

public java.lang.Class<?> loadClass()

Loads the referenced class, returning a Class<?> reference for the referenced class.

Returns:

The Class<?> reference for the referenced class.

Throws:

java.lang.IllegalArgumentException - if the class could not be loaded.

getClassName

protected java.lang.String getClassName()

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

Returns:

The class name.

getClassInfo

public ClassInfo getClassInfo()

Get the class info.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

protected void toString(boolean useSimpleNames,
                        java.lang.StringBuilder buf)

Render to string.

Parameters:

useSimpleNames - if true, use just the simple name of each class.

buf - the buf

findReferencedClassInfo

protected void findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo,
                                       java.util.Set<ClassInfo> refdClassInfo,
                                       LogNode log)

Get ClassInfo objects for any classes referenced by this object.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

toStringWithSimpleNames

public java.lang.String toStringWithSimpleNames()

Render to string, using only simple names for classes.

Returns:

the string representation, using simple names for classes.

toString

public java.lang.String toString()

Render to string.

Overrides:

toString in class java.lang.Object

Returns:

the string representation.