Class ClassFileLocator.ForModuleFile

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, ClassFileLocator
    Enclosing interface:
    ClassFileLocator

    @Enhance
    public static class ClassFileLocator.ForModuleFile
    extends java.lang.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.
    • Field Detail

      • JMOD_FILE_EXTENSION

        private static final java.lang.String JMOD_FILE_EXTENSION
        The file extension of a modular Java package.
        See Also:
        Constant Field Values
      • BOOT_LOCATIONS

        private static final java.util.List<java.lang.String> BOOT_LOCATIONS
        A list of potential locations of the boot path for different platforms.
      • zipFile

        private final java.util.zip.ZipFile zipFile
        The represented jmod file.
    • Constructor Detail

      • ForModuleFile

        public ForModuleFile​(java.util.zip.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 java.io.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:
        java.io.IOException - If an I/O error occurs.
      • ofBootPath

        public static ClassFileLocator ofBootPath​(java.io.File bootPath)
                                           throws java.io.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:
        java.io.IOException - If an I/O error occurs.
      • ofModulePath

        public static ClassFileLocator ofModulePath()
                                             throws java.io.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:
        java.io.IOException - If an I/O exception occurs.
      • ofModulePath

        public static ClassFileLocator ofModulePath​(java.lang.String modulePath)
                                             throws java.io.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:
        java.io.IOException - If an I/O exception occurs.
      • ofModulePath

        public static ClassFileLocator ofModulePath​(java.lang.String modulePath,
                                                    java.lang.String baseFolder)
                                             throws java.io.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:
        java.io.IOException - If an I/O exception occurs.
      • of

        public static ClassFileLocator of​(java.io.File file)
                                   throws java.io.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:
        java.io.IOException - If an I/O error occurs.
      • locate

        public ClassFileLocator.Resolution locate​(java.lang.String name)
                                           throws java.io.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:
        java.io.IOException - If reading a class file causes an error.
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException