Package sootup.java.bytecode.frontend.inputlocation

Class ModuleFinder

java.lang.Object

sootup.java.bytecode.frontend.inputlocation.ModuleFinder

public class ModuleFinder
extends Object

Discovers all modules in a given module path. For automatic modules, names are generated. Supports exploded modules, modular jars, and automatic modules as defined in the official documentation:

Author:

Andreas Dann on 28.06.18

See Also:

• ModuleFinder

Constructor Summary

Constructors

Constructor	Description
ModuleFinder(@NonNull Path modulePath)
ModuleFinder(@NonNull Path modulePath, @NonNull FileSystem fileSystem, @NonNull SourceType sourceType, @NonNull List<BodyInterceptor> bodyInterceptors)	Helper Class to discover modules in a given module path.
ModuleFinder(@NonNull Path modulePath, @NonNull SourceType sourceType, @NonNull List<BodyInterceptor> bodyInterceptors)

Method Summary

Modifier and Type	Method	Description
static @NonNull String	createModuleNameForAutomaticModule(@NonNull Path path)	Creates a name for an automatic module based on the name of a jar file.
boolean	equals(Object o)
@NonNull Collection<ModuleSignature>	getAllModules(@NonNull IdentifierFactory identifierFactory)	Discover all modules in the module path.
@Nullable AnalysisInputLocation	getModule(@NonNull ModuleSignature moduleName, @NonNull IdentifierFactory identifierFactory)	Returns the input location that manages the module.
@NonNull Optional<JavaModuleInfo>	getModuleInfo(ModuleSignature sig, @NonNull IdentifierFactory identifierFactory)
@NonNull Set<ModuleSignature>	getModules(@NonNull IdentifierFactory identifierFactory)
int	hashCode()
boolean	hasMoreToResolve()

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleFinder

public ModuleFinder(@NonNull Path modulePath,
 @NonNull FileSystem fileSystem,
 @NonNull SourceType sourceType,
 @NonNull List<BodyInterceptor> bodyInterceptors)

Helper Class to discover modules in a given module path.

Parameters:

modulePath - the module path

sourceType -

ModuleFinder

public ModuleFinder(@NonNull Path modulePath,
 @NonNull SourceType sourceType,
 @NonNull List<BodyInterceptor> bodyInterceptors)

ModuleFinder

public ModuleFinder(@NonNull Path modulePath)

Method Details

hasMoreToResolve

public boolean hasMoreToResolve()

getModuleInfo

public @NonNull Optional<JavaModuleInfo> getModuleInfo(ModuleSignature sig,
 @NonNull IdentifierFactory identifierFactory)

getModules

public @NonNull Set<ModuleSignature> getModules(@NonNull IdentifierFactory identifierFactory)

getModule

public @Nullable AnalysisInputLocation getModule(@NonNull ModuleSignature moduleName,
 @NonNull IdentifierFactory identifierFactory)

Returns the input location that manages the module.

Parameters:

moduleName - the module name

identifierFactory - the factory that creates the signatures of discovered modules

Returns:

the input location that resolves classes contained in the module

getAllModules

public @NonNull Collection<ModuleSignature> getAllModules(@NonNull IdentifierFactory identifierFactory)

Discover all modules in the module path.

Parameters:

identifierFactory - the factory that creates the signatures of discovered modules

Returns:

the names of all modules found

createModuleNameForAutomaticModule

public static @NonNull String createModuleNameForAutomaticModule(@NonNull Path path)

Creates a name for an automatic module based on the name of a jar file. The implementation is consistent with parsing module names in the JDK 9.

Parameters:

path - to the jar file

Returns:

the name of the automatic module

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object