org.netbeans.spi.java.project.classpath

Interface ProjectModulesModifier

public interface ProjectModulesModifier

Allows to update the module declaration in projects which support JDK9. For modular projects, it is not sufficient just to add artifacts on classpath - modular projects cannot access unnamed module, so the project would not see such classes/resources during compilation. Even if added to the module path, a directive needs to be added so that compiler and runtime honour the dependency.

This SPI allows the project implementation for modular project to diverge additions to a more suitable classpath, and to update the module information.

Project-specific implementation should be placed in project lookup. If not present, default implementation will handle the requests, so that artifacts, libraries and projects will land on JavaClassPathConstants.MODULE_COMPILE_PATH or JavaClassPathConstants.MODULE_EXECUTE_PATH respectively. The default implementation does nothing for projects (sources), which do not use module-info declaration, although they target JDK 9.

Since:

1.70

Method Summary

Modifier and Type	Method and Description
boolean	addRequiredModules(String pathType, FileObject projectArtifact, Collection<URL> locations) Adds "requires" clauses to module-info.
Map<URL,Collection<ClassPath>>	findModuleUsages(FileObject projectArtifact, Collection<URL> locations) Finds source groups which use the specified modules.
String	provideModularClasspath(FileObject projectArtifact, String classPathType) Translates the classpath type into a proper modular one, if necessary.
boolean	removeRequiredModules(String pathType, FileObject projectArtifact, Collection<URL> locations) Removes "requires" clauses from module-info.

Method Detail

provideModularClasspath

String provideModularClasspath(FileObject projectArtifact,
                               String classPathType)

Translates the classpath type into a proper modular one, if necessary. If the project is modular, artifacts added to ClassPath.COMPILE does not make sense, since it is inaccessible (without specific startup parameters), so modular project may need to diverge the request to some other classpath type. If the project is not modular, or modular project can use artifacts from the original classpath type, the value of null should be returned. If null is returned, the ProjectModulesModifier.addRequiredModules(java.lang.String, org.openide.filesystems.FileObject, java.util.Collection<java.net.URL>) or ProjectModulesModifier.removeRequiredModules(java.lang.String, org.openide.filesystems.FileObject, java.util.Collection<java.net.URL>) should not be called.

Parameters:

classPathType - original classpath type

projectArtifact - source, directory which will determine the proper module-info.java

Returns:

modular replacement for the classPathType.

addRequiredModules

boolean addRequiredModules(String pathType,
                           FileObject projectArtifact,
                           Collection<URL> locations)
                    throws IOException

Adds "requires" clauses to module-info. "requires" directive will be created for each of the module names in module-info which applies to the "source" file. The implementation may ignore requests for classpath types, which do not interact with the module system.

Parameters:

projectArtifact - source, directory which will determine the proper module-info.java

locations - module names to add required directives for

pathType - the original path type

Returns:

true, if some modification has been made

Throws:

IOException - on error

removeRequiredModules

boolean removeRequiredModules(String pathType,
                              FileObject projectArtifact,
                              Collection<URL> locations)
                       throws IOException

Removes "requires" clauses from module-info. Requires directives will be removed for all modules in the "moduleNames". The implementation may ignore requests for classpath types, which do not interact with the module system.

Parameters:

projectArtifact - source, directory which will determine the proper module-info.java

locations - module names whose required directives should be removed

pathType - the original path type

Returns:

true, if some modification has been made

Throws:

IOException - on error

findModuleUsages

@NonNull
Map<URL,Collection<ClassPath>> findModuleUsages(FileObject projectArtifact,
                                                         Collection<URL> locations)

Finds source groups which use the specified modules. The implementation should find all SourceGroups whose configuation (not content! like individual java sources) references the specified library/module. The call is used, for example, to determine whether removal of a library would break some modules, and what those modules are.

Parameters:

projectArtifact - project artifact a file owned by a project.

locations - locations whose usage should be found

Returns:

usage map