com.hazelcast.shaded.io.github.classgraph.ScanResultObject Maven / Gradle / Ivy
/*
* This file is part of ClassGraph.
*
* Author: Luke Hutchison
*
* Hosted at: https://github.com/classgraph/classgraph
*
* --
*
* The MIT License (MIT)
*
* Copyright (c) 2019 Luke Hutchison
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without
* limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
* LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
* EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
* OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.hazelcast.shaded.io.github.classgraph;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import nonapi.com.hazelcast.shaded.io.github.classgraph.utils.LogNode;
/**
* A superclass of objects accessible from a {@link ScanResult} that are associated with a {@link ClassInfo} object.
*/
abstract class ScanResultObject {
/** The scan result. */
transient protected ScanResult scanResult;
/** The associated {@link ClassInfo} object. */
private transient ClassInfo classInfo;
/** The class ref, once the class is loaded. */
protected transient Class classRef;
// -------------------------------------------------------------------------------------------------------------
/**
* Set ScanResult backreferences in info objects after scan has completed.
*
* @param scanResult
* the scan result
*/
void setScanResult(final ScanResult scanResult) {
this.scanResult = scanResult;
}
/**
* Get {@link ClassInfo} objects for any classes referenced by this object.
*
* @param log
* the log
* @return the referenced class info.
*/
final Set findReferencedClassInfo(final LogNode log) {
final Set refdClassInfo = new LinkedHashSet<>();
if (scanResult != null) {
findReferencedClassInfo(scanResult.classNameToClassInfo, refdClassInfo, log);
}
return refdClassInfo;
}
/**
* Get {@link ClassInfo} objects for any classes referenced by this object.
*
* @param classNameToClassInfo
* the map from class name to {@link ClassInfo}.
* @param refdClassInfo
* the referenced class info
* @param log
* the log
*/
protected void findReferencedClassInfo(final Map classNameToClassInfo,
final Set refdClassInfo, final LogNode log) {
final ClassInfo ci = getClassInfo();
if (ci != null) {
refdClassInfo.add(ci);
}
}
// -------------------------------------------------------------------------------------------------------------
/**
* The name of the class (used by {@link #getClassInfo()} to fetch the {@link ClassInfo} object for the class).
*
* @return The class name.
*/
protected abstract String getClassName();
/**
* Get the {@link 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, {@link #loadClass()} may be able to load the referenced class by name.
*
* @return The {@link ClassInfo} object for the referenced class.
*/
ClassInfo getClassInfo() {
if (classInfo == null) {
if (scanResult == null) {
return null;
}
final String className = getClassName();
if (className == null) {
throw new IllegalArgumentException("Class name is not set");
}
classInfo = scanResult.getClassInfo(className);
}
return classInfo;
}
/**
* Get the class name by calling getClassInfo().getName(), or as a fallback, by calling getClassName().
*
* @return the class name
*/
private String getClassInfoNameOrClassName() {
String className;
ClassInfo ci = null;
try {
ci = getClassInfo();
} catch (final IllegalArgumentException e) {
// Just ignore wrong access to array classInfo
}
if (ci == null) {
ci = classInfo;
}
if (ci != null) {
// Get class name from getClassInfo().getName()
className = ci.getName();
} else {
// Get class name from getClassName()
className = getClassName();
}
if (className == null) {
throw new IllegalArgumentException("Class name is not set");
}
return className;
}
// -------------------------------------------------------------------------------------------------------------
/**
* Load the class named returned by {@link #getClassInfo()}, or if that returns null, the class named by
* {@link #getClassName()}. Returns a {@code Class} reference for the class, cast to the requested superclass
* or interface type.
*
* @param
* the superclass or interface type
* @param superclassOrInterfaceType
* The type to cast the resulting class reference to.
* @param ignoreExceptions
* If true, ignore classloading exceptions and return null on failure.
* @return The {@code Class} reference for the referenced class, or null if the class could not be loaded (or
* casting failed) and ignoreExceptions is true.
* @throws IllegalArgumentException
* if the class could not be loaded or cast, and ignoreExceptions was false.
*/
Class loadClass(final Class superclassOrInterfaceType, final boolean ignoreExceptions) {
if (classRef == null) {
final String className = getClassInfoNameOrClassName();
if (scanResult != null) {
classRef = scanResult.loadClass(className, superclassOrInterfaceType, ignoreExceptions);
} else {
// Fallback, if scanResult is not set
try {
classRef = Class.forName(className);
} catch (final Throwable t) {
if (!ignoreExceptions) {
throw new IllegalArgumentException("Could not load class " + className, t);
}
}
}
}
@SuppressWarnings("unchecked")
final Class classT = (Class) classRef;
return classT;
}
/**
* Load the class named returned by {@link #getClassInfo()}, or if that returns null, the class named by
* {@link #getClassName()}. Returns a {@code Class} reference for the class, cast to the requested superclass
* or interface type.
*
* @param
* the superclass or interface type
* @param superclassOrInterfaceType
* The type to cast the resulting class reference to.
* @return The {@code Class} reference for the referenced class, or null if the class could not be loaded (or
* casting failed) and ignoreExceptions is true.
* @throws IllegalArgumentException
* if the class could not be loaded or cast, and ignoreExceptions was false.
*/
Class loadClass(final Class superclassOrInterfaceType) {
return loadClass(superclassOrInterfaceType, /* ignoreExceptions = */ false);
}
/**
* Load the class named returned by {@link #getClassInfo()}, or if that returns null, the class named by
* {@link #getClassName()}. Returns a {@code Class} reference for the class.
*
* @param ignoreExceptions
* If true, ignore classloading exceptions and return null on failure.
* @return The {@code Class} reference for the referenced class, or null if the class could not be loaded and
* ignoreExceptions is true.
* @throws IllegalArgumentException
* if the class could not be loaded and ignoreExceptions was false.
*/
Class loadClass(final boolean ignoreExceptions) {
if (classRef == null) {
final String className = getClassInfoNameOrClassName();
if (scanResult != null) {
classRef = scanResult.loadClass(className, ignoreExceptions);
} else {
// Fallback, if scanResult is not set
try {
classRef = Class.forName(className);
} catch (final Throwable t) {
if (!ignoreExceptions) {
throw new IllegalArgumentException("Could not load class " + className, t);
}
}
}
}
return classRef;
}
/**
* Load the class named returned by {@link #getClassInfo()}, or if that returns null, the class named by
* {@link #getClassName()}. Returns a {@code Class} reference for the class.
*
* @return The {@code Class} reference for the referenced class.
* @throws IllegalArgumentException
* if the class could not be loaded.
*/
Class loadClass() {
return loadClass(/* ignoreExceptions = */ false);
}
// -------------------------------------------------------------------------------------------------------------
/**
* Render to string.
*
* @param useSimpleNames
* if true, use just the simple name of each class.
* @param buf
* the buf
*/
protected abstract void toString(final boolean useSimpleNames, StringBuilder buf);
/**
* Render to string, with simple names for classes if useSimpleNames is true.
*
* @param useSimpleNames
* if true, use just the simple name of each class.
* @return the string representation.
*/
String toString(final boolean useSimpleNames) {
final StringBuilder buf = new StringBuilder();
toString(useSimpleNames, buf);
return buf.toString();
}
/**
* Render to string, using only simple
* names for classes.
*
* @return the string representation, using simple names for classes.
*/
public String toStringWithSimpleNames() {
final StringBuilder buf = new StringBuilder();
toString(/* useSimpleNames = */ true, buf);
return buf.toString();
}
/**
* Render to string.
*
* @return the string representation.
*/
@Override
public String toString() {
final StringBuilder buf = new StringBuilder();
toString(/* useSimpleNames = */ false, buf);
return buf.toString();
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy