OpenJDK 27 · jdk.internal.module.ModulePath · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	ModulePath.Patterns Patterns used to derive the module name from a JAR file name.

Modifier and Type	Field and Description
private static final Attributes.Name	AUTOMATIC_MODULE_NAME
private final Map<String, ModuleReference>	cachedModules
private final Path[]	entries
private final boolean	isLinkPhase
private static final String	MODULE_INFO
private static final PerfCounter	moduleCount
private int	next
private final ModulePatcher	patcher
private final Runtime.Version	releaseVersion
private static final PerfCounter	scanTime
private static final String	SERVICES_PREFIX

Access	Constructor and Description
private	ModulePath(Runtime.Version version, boolean isLinkPhase, ModulePatcher patcher, Path... entries)

Method Summary

Modifier and Type	Method and Description
private static String	cleanModuleName(String mn) Clean up candidate module name derived from a JAR file name.
private ModuleDescriptor	deriveModuleDescriptor(JarFile jf) Treat the given JAR file as a module as follows: 1.
private Set<String>	explodedPackages(Path dir)
private String	fileName(ModuleReference mref) Returns a string with the file name of the module if possible.
public Optional<ModuleReference>	find(String name) Implements java.lang.module.ModuleFinder.find. Finds a reference to a module of a given name.
public Set<ModuleReference>	findAll() Implements java.lang.module.ModuleFinder.findAll. Returns the set of all module references that this finder can locate.
private boolean	hasNextEntry() Returns `true` if there are additional entries to scan
private boolean	isDefaultFileSystem(Path path) Return true if a path locates a path in the default file system
private boolean	isHidden(Path file) Returns true if the given file exists and is a hidden file
private Set<String>	jarPackages(JarFile jf)
private Set<String>	jmodPackages(JmodFile jf)
private String	nextLine(BufferedReader reader) Reads the next line from the given reader and trims it of comments and leading/trailing white space.
public static ModuleFinder	of(ModulePatcher patcher, Path... entries) Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.
public static ModuleFinder	of(Path... entries) Hides java.lang.module.ModuleFinder.of. Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.
public static ModuleFinder	of(Runtime.Version The release version to use for multi-release JAR files version, boolean `true` if the link phase to locate JMOD files isLinkPhase, Path... entries) Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.
private static String	packageName(String cn) Maps a type name to its package name.
private ModuleReference	readExplodedModule(Path dir) Returns a `ModuleReference` to an exploded module on the file system or `null` if `module-info.class` not found.
private ModuleReference	readJar(Path file) Returns a `ModuleReference` to a module in modular JAR file on the file system.
private ModuleReference	readJMod(Path file) Returns a `ModuleReference` to a module in JMOD file on the file system.
private ModuleReference	readModule(Path entry, BasicFileAttributes attrs) Reads a packaged or exploded module, returning a `ModuleReference` to the module.
private Map<String, ModuleReference>	scan(Path entry) Scan the given module path entry.
private Map<String, ModuleReference>	Returns: a map of module name to ModuleReference for the modules found in the directory scanDirectory(Path dir) Scans the given directory for packaged or exploded modules.
private void	scanNextEntry() Scans the next entry on the module path.
private Optional<String>	toPackageName(String name) Maps the name of an entry in a JAR or ZIP file to a package name.
private Optional<String>	toPackageName(Path file, String separator) Maps the relative path of an entry in an exploded module to a package name.
private Optional<String>	toServiceName(String cf) Returns the service type corresponding to the name of a services configuration file if it is a legal type name.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AUTOMATIC_MODULE_NAME	back to summary
private static final Attributes.Name AUTOMATIC_MODULE_NAME

cachedModules	back to summary
private final Map<String, ModuleReference> cachedModules

entries	back to summary
private final Path[] entries

isLinkPhase	back to summary
private final boolean isLinkPhase

MODULE_INFO	back to summary
private static final String MODULE_INFO

moduleCount	back to summary
private static final PerfCounter moduleCount

next	back to summary
private int next

patcher	back to summary
private final ModulePatcher patcher

releaseVersion	back to summary
private final Runtime.Version releaseVersion

scanTime	back to summary
private static final PerfCounter scanTime

SERVICES_PREFIX	back to summary
private static final String SERVICES_PREFIX

ModulePath	back to summary
private ModulePath(Runtime.Version version, boolean isLinkPhase, ModulePatcher patcher, Path... entries)

Method Detail

cleanModuleName	back to summary
private static String cleanModuleName(String mn) Clean up candidate module name derived from a JAR file name.

deriveModuleDescriptor	back to summary
private ModuleDescriptor deriveModuleDescriptor(JarFile jf) throws IOException Treat the given JAR file as a module as follows: 1. The value of the Automatic-Module-Name attribute is the module name 2. The version, and the module name when the Automatic-Module-Name attribute is not present, is derived from the file ame of the JAR file 3. All packages are derived from the .class files in the JAR file 4. The contents of any META-INF/services configuration files are mapped to "provides" declarations 5. The Main-Class attribute in the main attributes of the JAR manifest is mapped to the module descriptor mainClass if possible

deriveModuleDescriptor

back to summary

private ModuleDescriptor deriveModuleDescriptor(JarFile jf) throws IOException

Treat the given JAR file as a module as follows: 1. The value of the Automatic-Module-Name attribute is the module name 2. The version, and the module name when the Automatic-Module-Name attribute is not present, is derived from the file ame of the JAR file 3. All packages are derived from the .class files in the JAR file 4. The contents of any META-INF/services configuration files are mapped to "provides" declarations 5. The Main-Class attribute in the main attributes of the JAR manifest is mapped to the module descriptor mainClass if possible

explodedPackages	back to summary
private Set<String> explodedPackages(Path dir)

fileName	back to summary
private String fileName(ModuleReference mref) Returns a string with the file name of the module if possible. If the module location is not a file URI then return the URI as a string.

find back to summary

find	back to summary
public Optional<ModuleReference> find(String name) Implements java.lang.module.ModuleFinder.find. Doc from java.lang.module.ModuleFinder.find. Finds a reference to a module of a given name. A `ModuleFinder` provides a consistent view of the modules that it locates. If `find` is invoked several times to locate the same module (by name) then it will return the same result each time. If a module is located then it is guaranteed to be a member of the set of modules returned by the `findAll` method. Annotations @Override

public Optional<ModuleReference> find(String name)

Implements java.lang.module.ModuleFinder.find.

Doc from java.lang.module.ModuleFinder.find.

Finds a reference to a module of a given name.

A ModuleFinder provides a consistent view of the modules that it locates. If find is invoked several times to locate the same module (by name) then it will return the same result each time. If a module is located then it is guaranteed to be a member of the set of modules returned by the findAll method.

Annotations

@Override

findAll back to summary

findAll	back to summary
public Set<ModuleReference> findAll() Implements java.lang.module.ModuleFinder.findAll. Doc from java.lang.module.ModuleFinder.findAll. Returns the set of all module references that this finder can locate. A `ModuleFinder` provides a consistent view of the modules that it locates. If `findAll` is invoked several times then it will return the same (equals) result each time. For each `ModuleReference` element in the returned set then it is guaranteed that `find` will locate the `ModuleReference` if invoked to find that module. Annotations @Override

public Set<ModuleReference> findAll()

Implements java.lang.module.ModuleFinder.findAll.

Doc from java.lang.module.ModuleFinder.findAll.

Returns the set of all module references that this finder can locate.

A ModuleFinder provides a consistent view of the modules that it locates. If findAll is invoked several times then it will return the same (equals) result each time. For each ModuleReference element in the returned set then it is guaranteed that find will locate the ModuleReference if invoked to find that module.

Annotations

@Override

hasNextEntry	back to summary
private boolean hasNextEntry() Returns `true` if there are additional entries to scan

isDefaultFileSystem	back to summary
private boolean isDefaultFileSystem(Path path) Return true if a path locates a path in the default file system

isHidden	back to summary
private boolean isHidden(Path file) Returns true if the given file exists and is a hidden file

jarPackages	back to summary
private Set<String> jarPackages(JarFile jf)

jmodPackages	back to summary
private Set<String> jmodPackages(JmodFile jf)

nextLine	back to summary
private String nextLine(BufferedReader reader) throws IOException Reads the next line from the given reader and trims it of comments and leading/trailing white space. Returns null if the reader is at EOF.

of	back to summary
public static ModuleFinder of(ModulePatcher patcher, Path... entries) Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules. The modules may be patched by the given ModulePatcher.

of	back to summary
public static ModuleFinder of(Path... entries) Hides java.lang.module.ModuleFinder.of. Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.

back to summary

public static ModuleFinder of(Path... entries)

Hides java.lang.module.ModuleFinder.of.

Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.

of back to summary

of	back to summary
public static ModuleFinder of(Runtime.Version version, boolean isLinkPhase, Path... entries) Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules. Parameters version:Runtime.Version The release version to use for multi-release JAR files isLinkPhase:boolean `true` if the link phase to locate JMOD files

public static ModuleFinder of(Runtime.Version version, boolean isLinkPhase, Path... entries)

Returns a ModuleFinder that locates modules on the file system by searching a sequence of directories and/or packaged modules.

Parameters

version:Runtime.Version: The release version to use for multi-release JAR files
isLinkPhase:boolean: true if the link phase to locate JMOD files

packageName	back to summary
private static String packageName(String cn) Maps a type name to its package name.

readExplodedModule	back to summary
private ModuleReference readExplodedModule(Path dir) throws IOException Returns a `ModuleReference` to an exploded module on the file system or `null` if `module-info.class` not found.

readJar	back to summary
private ModuleReference readJar(Path file) throws IOException Returns a `ModuleReference` to a module in modular JAR file on the file system.

readJMod	back to summary
private ModuleReference readJMod(Path file) throws IOException Returns a `ModuleReference` to a module in JMOD file on the file system.

readModule back to summary

readModule	back to summary
private ModuleReference readModule(Path entry, BasicFileAttributes attrs) throws IOException Reads a packaged or exploded module, returning a `ModuleReference` to the module. Returns `null` if the entry is not recognized. Exceptions IOException: if an I/O error occurs FindException: if an error occurs parsing its module descriptor

private ModuleReference readModule(Path entry, BasicFileAttributes attrs) throws IOException

Reads a packaged or exploded module, returning a ModuleReference to the module. Returns null if the entry is not recognized.

Exceptions

IOException:: if an I/O error occurs
FindException:: if an error occurs parsing its module descriptor

scan	back to summary
private Map<String, ModuleReference> scan(Path entry) Scan the given module path entry. If the entry is a directory then it is a directory of modules or an exploded module. If the entry is a regular file then it is assumed to be a packaged module. Exceptions FindException: if an error occurs scanning the entry

scan

back to summary

private Map<String, ModuleReference> scan(Path entry)

Scan the given module path entry. If the entry is a directory then it is a directory of modules or an exploded module. If the entry is a regular file then it is assumed to be a packaged module.

Exceptions

FindException:: if an error occurs scanning the entry

scanDirectory	back to summary
private Map<String, ModuleReference> scanDirectory(Path dir) throws IOException Scans the given directory for packaged or exploded modules. Returns:Map<String, ModuleReference> a map of module name to ModuleReference for the modules found in the directory Exceptions IOException: if an I/O error occurs FindException: if an error occurs scanning the entry or the directory contains two or more modules with the same name

scanDirectory

back to summary

private Map<String, ModuleReference> scanDirectory(Path dir) throws IOException

Scans the given directory for packaged or exploded modules.

Returns:Map<String, ModuleReference>

a map of module name to ModuleReference for the modules found in the directory

Exceptions

IOException:: if an I/O error occurs
FindException:: if an error occurs scanning the entry or the directory contains two or more modules with the same name

scanNextEntry	back to summary
private void scanNextEntry() Scans the next entry on the module path. A no-op if all entries have already been scanned. Exceptions FindException: if an error occurs scanning the next entry

scanNextEntry

back to summary

private void scanNextEntry()

Scans the next entry on the module path. A no-op if all entries have already been scanned.

Exceptions

FindException:: if an error occurs scanning the next entry

toPackageName	back to summary
private Optional<String> toPackageName(String name) Maps the name of an entry in a JAR or ZIP file to a package name. Exceptions InvalidModuleDescriptorException: if the name is a class file in the top-level directory of the JAR/ZIP file (and it's not module-info.class)

toPackageName

back to summary

private Optional<String> toPackageName(String name)

Maps the name of an entry in a JAR or ZIP file to a package name.

Exceptions

InvalidModuleDescriptorException:: if the name is a class file in the top-level directory of the JAR/ZIP file (and it's not module-info.class)

toPackageName	back to summary
private Optional<String> toPackageName(Path file, String separator) Maps the relative path of an entry in an exploded module to a package name. Exceptions InvalidModuleDescriptorException: if the name is a class file in the top-level directory (and it's not module-info.class)

toPackageName

back to summary

private Optional<String> toPackageName(Path file, String separator)

Maps the relative path of an entry in an exploded module to a package name.

Exceptions

InvalidModuleDescriptorException:: if the name is a class file in the top-level directory (and it's not module-info.class)

toServiceName	back to summary
private Optional<String> toServiceName(String cf) Returns the service type corresponding to the name of a services configuration file if it is a legal type name. For example, if called with "META-INF/services/p.S" then this method returns a container with the value "p.S".

Modifier and Type	Field and Description
pack-priv static final Pattern	DASH_VERSION
pack-priv static final Pattern	LEADING_DOTS
pack-priv static final Pattern	NON_ALPHANUM
pack-priv static final Pattern	REPEATING_DOTS
pack-priv static final Pattern	TRAILING_DOTS

public Class ModulePath

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ModulePath.Patterns

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail