net.bytebuddy.dynamic

Class ClassFileLocator.ForModuleFile

java.lang.Object

net.bytebuddy.dynamic.ClassFileLocator.ForModuleFile

All Implemented Interfaces:

Closeable, AutoCloseable, ClassFileLocator

Enclosing interface:

ClassFileLocator

@HashCodeAndEqualsPlugin.Enhance
public static class ClassFileLocator.ForModuleFile
extends Object
implements ClassFileLocator

A class file locator that locates classes within a Java jmod file. This class file locator should not be used for reading modular jar files for which ClassFileLocator.ForJarFile is appropriate.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.ClassFileLocator

ClassFileLocator.AgentBased, ClassFileLocator.Compound, ClassFileLocator.ForClassLoader, ClassFileLocator.ForFolder, ClassFileLocator.ForJarFile, ClassFileLocator.ForModule, ClassFileLocator.ForModuleFile, ClassFileLocator.ForUrl, ClassFileLocator.NoOp, ClassFileLocator.PackageDiscriminating, ClassFileLocator.Resolution, ClassFileLocator.Simple

Field Summary

Fields inherited from interface net.bytebuddy.dynamic.ClassFileLocator

CLASS_FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
ForModuleFile(ZipFile zipFile) Creates a new class file locator for a jmod file.

Method Summary

Modifier and Type	Method and Description
void	close()
ClassFileLocator.Resolution	locate(String name) Locates the class file for a given type and returns the binary data of the class file.
static ClassFileLocator	of(File file) Returns a class file locator for the given module file.
static ClassFileLocator	ofBootPath() Creates a new class file locator for this VM's boot module path.
static ClassFileLocator	ofBootPath(File bootPath) Creates a new class file locator for a Java boot module path.
static ClassFileLocator	ofModulePath() Resolves a class file locator for this VM's Java module path that reads class files directly from the file system.
static ClassFileLocator	ofModulePath(String modulePath) Resolves a class file locator for a Java module path that reads class files directly from the file system.
static ClassFileLocator	ofModulePath(String modulePath, String baseFolder) Resolves a class file locator for a Java module path that reads class files directly from the file system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForModuleFile

public ForModuleFile(ZipFile zipFile)

Creates a new class file locator for a jmod file.

Parameters:

zipFile - The represented jmod file.

Method Detail

ofBootPath

public static ClassFileLocator ofBootPath()
                                   throws IOException

Creates a new class file locator for this VM's boot module path.

Returns:

A class file locator for this VM's boot module path.

Throws:

IOException - If an I/O error occurs.

ofBootPath

public static ClassFileLocator ofBootPath(File bootPath)
                                   throws IOException

Creates a new class file locator for a Java boot module path.

Parameters:

bootPath - The boot path folder.

Returns:

A class file locator for this VMs boot module path.

Throws:

IOException - If an I/O error occurs.

ofModulePath

public static ClassFileLocator ofModulePath()
                                     throws IOException

Resolves a class file locator for this VM's Java module path that reads class files directly from the file system.

Note: The resulting class file locator does not include classes of the bootstrap class loader.

Returns:

A class file locator for the class path.

Throws:

IOException - If an I/O exception occurs.

ofModulePath

public static ClassFileLocator ofModulePath(String modulePath)
                                     throws IOException

Resolves a class file locator for a Java module path that reads class files directly from the file system. All elements of the module path are resolved relative to this VM's user.dir.

Note: The resulting class file locator does not include classes of the bootstrap class loader.

Parameters:

modulePath - The module path to scan with the elements separated by path.separator.

Returns:

A class file locator for the class path.

Throws:

IOException - If an I/O exception occurs.

ofModulePath

public static ClassFileLocator ofModulePath(String modulePath,
                                            String baseFolder)
                                     throws IOException

Resolves a class file locator for a Java module path that reads class files directly from the file system.

Note: The resulting class file locator does not include classes of the bootstrap class loader.

Parameters:

modulePath - The module path to scan with the elements separated by path.separator.

baseFolder - The relative location of the elements on the module path.

Returns:

A class file locator for the class path.

Throws:

IOException - If an I/O exception occurs.

of

public static ClassFileLocator of(File file)
                           throws IOException

Returns a class file locator for the given module file.

Parameters:

file - The module file.

Returns:

A class file locator for the given module

Throws:

IOException - If an I/O error occurs.

locate

public ClassFileLocator.Resolution locate(String name)
                                   throws IOException

Locates the class file for a given type and returns the binary data of the class file.

Specified by:

locate in interface ClassFileLocator

Parameters:

name - The name of the type to locate a class file representation for.

Returns:

Any binary representation of the type which might be illegal.

Throws:

IOException - If reading a class file causes an error.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException