[MNG-8195] Add DependencyResolverResult.getModuleName(Path) method

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 4.0.0-beta-4, 4.0.0
• Component/s: Dependencies
• Assignee: Guillaume Nodet
• Reporter: Tamas Cservenak
• Created: 09/Aug/24 09:55
• Updated: 16/Aug/24 09:19
• Resolved: 16/Aug/24 09:19

Description

Clarify the meaning of "module" in documentation, then add two methods for getting Java module information from a `DependencyResolverResult`:

• `getModuleName(Path)` returns a `java.lang.String`
• `getModuleDescription(Path)` returns a `java.lang.module.ModuleDescriptor`

"Get name" may seem redundant with "get description" because the name can be obtained from the description by `ModuleDescriptor.name()`. The difference is that "get name" fallbacks on the `Automatic-Module-Name` attribute of `META-INF/MANIFEST.MF` if the module descriptor is not found.

The rational for providing those methods in the API is because it allows to use the cache managed by the `DefaultDependencyResolverResult` implementation. It avoids decoding many times the `module-info.class` files. Plugins need those information for managing `--add-reads` and similar options.

Alternative: It would be more natural to have `getModuleName()` and `getModuleDescription()` methods in `Dependency`. But it would imply that dependency contains a `getPath()` method. I'm not sure why it is not already the case.

Issue Links

• links to: GH PR #1625
• links to: GitHub Pull Request #1625