Package io.github.classgraph

Class ModuleRef

java.lang.Object

io.github.classgraph.ModuleRef

All Implemented Interfaces:

Comparable<ModuleRef>

public class ModuleRef
extends Object
implements Comparable<ModuleRef>

A ModuleReference proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8.

Constructor Summary

Constructors

Constructor	Description
ModuleRef(Object moduleReference, Object moduleLayer)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ModuleRef o)
boolean	equals(Object obj)
ClassLoader	getClassLoader()
Object	getDescriptor()
Object	getLayer()
URI	getLocation()
File	getLocationFile()
String	getLocationStr()
String	getName()
List<String>	getPackages()
Object	getReference()
int	hashCode()
boolean	isSystemModule()
ModuleReaderProxy	open()	Open the module, returning a ModuleReaderProxy.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleRef

public ModuleRef(Object moduleReference,
                 Object moduleLayer)

Parameters:

moduleReference - The module reference, of JPMS type ModuleReference.

moduleLayer - The module layer, of JPMS type ModuleLayer

Method Detail

getName

public String getName()

Returns:

The module name, i.e. getReference().descriptor().name().

getReference

public Object getReference()

Returns:

The module reference (of JPMS type ModuleReference).

getLayer

public Object getLayer()

Returns:

The module layer (of JPMS type ModuleLayer).

getDescriptor

public Object getDescriptor()

Returns:

The module descriptor, i.e. getReference().descriptor() (of JPMS type ModuleDescriptor).

getPackages

public List<String> getPackages()

Returns:

The list of packages in the module. (Does not include non-package directories.)

getLocation

public URI getLocation()

Returns:

The module location, i.e. getReference().location(). Returns null for modules that do not have a location.

getLocationStr

public String getLocationStr()

Returns:

The module location as a string, i.e. getReference().location().toString(). Returns null for modules that do not have a location.

getLocationFile

public File getLocationFile()

Returns:

The module location as a File, i.e. new File(getReference().location()). Returns null for modules that do not have a location, or for system ("jrt:/") modules.

isSystemModule

public boolean isSystemModule()

Returns:

true if this module's location is a non-"file:/" ("jrt:/") URI, or if it has no location URI, or if it uses the (null) bootstrap ClassLoader, or if the module name starts with a system prefix ("java.", "jre.", etc.).

getClassLoader

public ClassLoader getClassLoader()

Returns:

The classloader for the module, i.e. moduleLayer.findLoader(getReference().descriptor().name()).

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ModuleRef o)

Specified by:

compareTo in interface Comparable<ModuleRef>

open

public ModuleReaderProxy open()
                       throws IOException

Open the module, returning a ModuleReaderProxy.

Returns:

A ModuleReaderProxy for the module.

Throws:

IOException - If the module cannot be opened.