com.hazelcast.shaded.io.github.classgraph.ModuleRef Maven / Gradle / Ivy
The newest version!
/*
* 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.io.File;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import com.hazelcast.shaded.nonapi.io.github.classgraph.reflection.ReflectionUtils;
import com.hazelcast.shaded.nonapi.io.github.classgraph.utils.CollectionUtils;
/** A ModuleReference proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8. */
public class ModuleRef implements Comparable {
/** The name of the module. */
private final String name;
/** The ModuleReference for the module. */
private final Object reference;
/** The ModuleLayer for the module. */
private final Object layer;
/** The ModuleDescriptor for the module. */
private final Object descriptor;
/** The packages in the module. */
private final List packages;
/** The location URI for the module (may be null). */
private final URI location;
/** The location URI for the module, as a cached string (may be null). */
private String locationStr;
/** A file formed from the location URI. The file will not exist if the location URI is a "jrt:" URI. */
private File locationFile;
/** The raw module version, or null if none. */
private String rawVersion;
/** The ClassLoader that loads classes in the module. May be null, to represent the bootstrap classloader. */
private final ClassLoader classLoader;
ReflectionUtils reflectionUtils;
/**
* Constructor.
*
* @param moduleReference
* The module reference, of JPMS type ModuleReference.
* @param moduleLayer
* The module layer, of JPMS type ModuleLayer
* @param reflectionUtils
* The ReflectionUtils instance.
*/
public ModuleRef(final Object moduleReference, final Object moduleLayer,
final ReflectionUtils reflectionUtils) {
if (moduleReference == null) {
throw new IllegalArgumentException("moduleReference cannot be null");
}
if (moduleLayer == null) {
throw new IllegalArgumentException("moduleLayer cannot be null");
}
this.reference = moduleReference;
this.layer = moduleLayer;
this.reflectionUtils = reflectionUtils;
this.descriptor = reflectionUtils.invokeMethod(/* throwException = */ true, moduleReference, "descriptor");
if (this.descriptor == null) {
// Should not happen
throw new IllegalArgumentException("moduleReference.descriptor() should not return null");
}
this.name = (String) reflectionUtils.invokeMethod(/* throwException = */ true, this.descriptor, "name");
@SuppressWarnings("unchecked")
final Set modulePackages = (Set) reflectionUtils.invokeMethod(/* throwException = */ true,
this.descriptor, "packages");
if (modulePackages == null) {
// Should not happen
throw new IllegalArgumentException("moduleReference.descriptor().packages() should not return null");
}
this.packages = new ArrayList<>(modulePackages);
CollectionUtils.sortIfNotEmpty(this.packages);
final Object optionalRawVersion = reflectionUtils.invokeMethod(/* throwException = */ true, this.descriptor,
"rawVersion");
if (optionalRawVersion != null) {
final Boolean isPresent = (Boolean) reflectionUtils.invokeMethod(/* throwException = */ true,
optionalRawVersion, "isPresent");
if (isPresent != null && isPresent) {
this.rawVersion = (String) reflectionUtils.invokeMethod(/* throwException = */ true,
optionalRawVersion, "get");
}
}
final Object moduleLocationOptional = reflectionUtils.invokeMethod(/* throwException = */ true,
moduleReference, "location");
if (moduleLocationOptional == null) {
// Should not happen
throw new IllegalArgumentException("moduleReference.location() should not return null");
}
final Object moduleLocationIsPresent = reflectionUtils.invokeMethod(/* throwException = */ true,
moduleLocationOptional, "isPresent");
if (moduleLocationIsPresent == null) {
// Should not happen
throw new IllegalArgumentException("moduleReference.location().isPresent() should not return null");
}
if ((Boolean) moduleLocationIsPresent) {
this.location = (URI) reflectionUtils.invokeMethod(/* throwException = */ true, moduleLocationOptional,
"get");
if (this.location == null) {
// Should not happen
throw new IllegalArgumentException("moduleReference.location().get() should not return null");
}
} else {
this.location = null;
}
// Find the classloader for the module
this.classLoader = (ClassLoader) reflectionUtils.invokeMethod(/* throwException = */ true, moduleLayer,
"findLoader", String.class, this.name);
}
/**
* Get the module name, i.e. {@code getReference().descriptor().name()}.
*
* @return The module name, i.e. {@code getReference().descriptor().name()}. Potentially null or empty.
*/
public String getName() {
return name;
}
/**
* Get the module reference (of JPMS type ModuleReference).
*
* @return The module reference (of JPMS type ModuleReference).
*/
public Object getReference() {
return reference;
}
/**
* Get the module layer (of JPMS type ModuleLayer).
*
* @return The module layer (of JPMS type ModuleLayer).
*/
public Object getLayer() {
return layer;
}
/**
* Get the module descriptor, i.e. {@code getReference().descriptor()} (of JPMS type ModuleDescriptor).
*
* @return The module descriptor, i.e. {@code getReference().descriptor()} (of JPMS type ModuleDescriptor).
*/
public Object getDescriptor() {
return descriptor;
}
/**
* Get a list of packages in the module. (Does not include non-package directories.)
*
* @return The list of packages in the module. (Does not include non-package directories.)
*/
public List getPackages() {
return packages;
}
/**
* Get the module location, i.e. {@code getReference().location()}. Returns null for modules that do not have a
* location.
*
* @return The module location, i.e. {@code getReference().location()}. Returns null for modules that do not
* have a location.
*/
public URI getLocation() {
return location;
}
/**
* Get the module location as a string, i.e. {@code getReference().location().toString()}. Returns null for
* modules that do not have a location.
*
* @return The module location as a string, i.e. {@code getReference().location().toString()}. Returns null for
* modules that do not have a location.
*/
public String getLocationStr() {
if (locationStr == null && location != null) {
locationStr = location.toString();
}
return locationStr;
}
/**
* Get the module location as a File, i.e. {@code new File(getReference().location())}. Returns null for modules
* that do not have a location, or for system (or jlinked) modules, which have "jrt:" location URIs that include
* only the module name and not the module jar location.
*
* @return The module location as a File, i.e. {@code new File(getReference().location())}. Returns null for
* modules that do not have a location, or for modules whole location is a "jrt:" URI.
*/
public File getLocationFile() {
if (locationFile == null && location != null && "file".equals(location.getScheme())) {
locationFile = new File(location);
}
return locationFile;
}
/**
* Get the raw version string of the module, or null if the module did not provide one.
*
* @return The raw version of the module, obtained by {@code ModuleReference#rawVersion().orElse(null)}.
*/
public String getRawVersion() {
return rawVersion;
}
/**
* Checks if this module is a system module.
*
* @return true if this module is a system module.
*/
public boolean isSystemModule() {
if (name == null || name.isEmpty()) {
return false;
}
return name.startsWith("java.") || name.startsWith("jdk.") || name.startsWith("javafx.")
|| name.startsWith("oracle.");
}
/**
* Get the class loader for the module.
*
* @return The classloader for the module, i.e.
* {@code moduleLayer.findLoader(getReference().descriptor().name())}.
*/
public ClassLoader getClassLoader() {
return classLoader;
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object obj) {
if (obj == this) {
return true;
} else if (!(obj instanceof ModuleRef)) {
return false;
}
final ModuleRef modRef = (ModuleRef) obj;
return modRef.reference.equals(this.reference) && modRef.layer.equals(this.layer);
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return reference.hashCode() * layer.hashCode();
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return reference.toString();
}
/* (non-Javadoc)
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
public int compareTo(final ModuleRef o) {
final int diff = this.name.compareTo(o.name);
return diff != 0 ? diff : this.hashCode() - o.hashCode();
}
// -------------------------------------------------------------------------------------------------------------
/**
* Open the module, returning a {@link ModuleReaderProxy}.
*
* @return A {@link ModuleReaderProxy} for the module.
* @throws IOException
* If the module cannot be opened.
*/
public ModuleReaderProxy open() throws IOException {
return new ModuleReaderProxy(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy