ClassGraph 4.8.179 · io.github.classgraph.AnnotationClassRef

Modifier and Type	Field and Description
private transient String	className The class name.
private String	typeDescriptorStr The type descriptor str.
private transient TypeSignature	typeSignature The type signature.

Access	Constructor and Description
pack-priv	AnnotationClassRef() Constructor.
pack-priv	AnnotationClassRef(final String the type descriptor str typeDescriptorStr) Constructor.

Method Summary

Modifier and Type	Method and Description
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 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 class info.
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 String	Returns: The name of the referenced class. getName() Get the name of the referenced class.
private TypeSignature	Returns: The type signature of the `Class<?>` reference. This will be a `ClassRefTypeSignature`, a `BaseTypeSignature`, or an `ArrayTypeSignature`. getTypeSignature() Get the type signature.
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. Loads the referenced class, returning a `Class<?`
public Class<?>	Returns: The `Class<?>` reference for the referenced class. loadClass() Overrides io.github.classgraph.ScanResultObject.loadClass. Loads the referenced class, returning a `Class<?`
pack-priv void	setScanResult(final ScanResult the scan result scanResult) Overrides io.github.classgraph.ScanResultObject.setScanResult. Set ScanResult backreferences in info objects after scan has completed.
protected void	toString(final boolean if true, use just the simple name of each class. useSimpleNames, final StringBuilder the buf buf) Implements abstract io.github.classgraph.ScanResultObject.toString. Render to string.

Inherited from io.github.classgraph.ScanResultObject:: findReferencedClassInfo findReferencedClassInfo loadClass loadClass toString toString toStringWithSimpleNames

className	back to summary
private transient String className The class name.

typeDescriptorStr	back to summary
private String typeDescriptorStr The type descriptor str.

typeSignature	back to summary
private transient TypeSignature typeSignature The type signature.

AnnotationClassRef	back to summary
pack-priv AnnotationClassRef() Constructor.

AnnotationClassRef	back to summary
pack-priv AnnotationClassRef(final String typeDescriptorStr) Constructor. Parameters typeDescriptorStr:String the type descriptor str

Method Detail

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

getClassInfo back to summary

getClassInfo	back to summary
public ClassInfo getClassInfo() Overrides io.github.classgraph.ScanResultObject.getClassInfo. Get the class info. 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 class info.

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

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

getName

back to summary

public String getName()

Get the name of the referenced class.

Returns:String: The name of the referenced class.

getTypeSignature back to summary

getTypeSignature	back to summary
private TypeSignature getTypeSignature() Get the type signature. Returns:TypeSignature The type signature of the `Class<?>` reference. This will be a `ClassRefTypeSignature`, a `BaseTypeSignature`, or an `ArrayTypeSignature`.

private TypeSignature getTypeSignature()

Get the type signature.

Returns:TypeSignature: The type signature of the Class<?> reference. This will be a ClassRefTypeSignature, a BaseTypeSignature, or an ArrayTypeSignature.

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. Loads the referenced class, returning a `Class<?>` reference for the referenced class. 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.

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

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. Loads the referenced class, returning a `Class<?>` reference for the referenced class. 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.

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

Returns:Class<?>

The Class<?> reference for the referenced class.

Annotations

@Override

Exceptions

IllegalArgumentException:: if the class could not be loaded.

setScanResult	back to summary
pack-priv void setScanResult(final ScanResult scanResult) Overrides io.github.classgraph.ScanResultObject.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.ScanResultObject.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

toString	back to summary
protected void toString(final boolean useSimpleNames, final StringBuilder buf) Implements abstract io.github.classgraph.ScanResultObject.toString. Doc from io.github.classgraph.ScanResultObject.toString. Render to string. Parameters useSimpleNames:boolean if true, use just the simple name of each class. buf:StringBuilder the buf Annotations @Override

toString

back to summary

protected void toString(final boolean useSimpleNames, final StringBuilder buf)

Implements abstract io.github.classgraph.ScanResultObject.toString.

Doc from io.github.classgraph.ScanResultObject.toString.

Render to string.

Parameters

useSimpleNames:boolean: if true, use just the simple name of each class.
buf:StringBuilder: the buf

Annotations

@Override

public Class AnnotationClassRef

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail