Package sootup.java.bytecode.frontend.inputlocation

Class JavaModulePathAnalysisInputLocation

java.lang.Object

sootup.java.bytecode.frontend.inputlocation.JavaModulePathAnalysisInputLocation

All Implemented Interfaces:

AnalysisInputLocation, ModuleInfoAnalysisInputLocation

public class JavaModulePathAnalysisInputLocation
extends Object
implements ModuleInfoAnalysisInputLocation

An implementation of the AnalysisInputLocation interface for the Java modulepath. Handles directories, archives (including wildcard denoted archives) as stated in the official documentation:

Author:

Andreas Dann created on 28.05.18

See Also:

• ModuleFinder

Constructor Summary

Constructors

Constructor	Description
JavaModulePathAnalysisInputLocation(@NonNull Path modulePath)	Creates a JavaModulePathAnalysisInputLocation which locates classes in the given module path.
JavaModulePathAnalysisInputLocation(@NonNull Path modulePath, @NonNull FileSystem fileSystem, @NonNull SourceType sourcetype)
JavaModulePathAnalysisInputLocation(@NonNull Path modulePath, @NonNull FileSystem fileSystem, @NonNull SourceType sourcetype, @NonNull List<BodyInterceptor> bodyInterceptors)	Creates a JavaModulePathAnalysisInputLocation which locates classes in the given module path.
JavaModulePathAnalysisInputLocation(@NonNull Path modulePath, @NonNull SourceType sourcetype)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull List<BodyInterceptor>	getBodyInterceptors()
@NonNull Optional<JavaSootClassSource>	getClassSource(@NonNull ClassType classType, @NonNull View view)	Create or find a class source for a given type.
@NonNull Stream<JavaSootClassSource>	getClassSources(@NonNull View view)	Scan the input location and create ClassSources for every compilation / interpretation unit.
protected Stream<JavaSootClassSource>	getClassSourcesInternal(@NonNull ModuleSignature moduleSignature, @NonNull View view)
@NonNull Optional<JavaModuleInfo>	getModuleInfo(ModuleSignature sig, View view)
@NonNull Set<ModuleSignature>	getModules(View view)
@NonNull Stream<JavaSootClassSource>	getModulesClassSources(@NonNull ModuleSignature moduleSignature, @NonNull View view)
@NonNull SourceType	getSourceType()	If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

JavaModulePathAnalysisInputLocation

public JavaModulePathAnalysisInputLocation(@NonNull Path modulePath)

Creates a JavaModulePathAnalysisInputLocation which locates classes in the given module path.

Parameters:

modulePath - The class path to search in The ClassProvider for generating SootClassSourcees for the files found on the class path

JavaModulePathAnalysisInputLocation

public JavaModulePathAnalysisInputLocation(@NonNull Path modulePath,
 @NonNull SourceType sourcetype)

JavaModulePathAnalysisInputLocation

public JavaModulePathAnalysisInputLocation(@NonNull Path modulePath,
 @NonNull FileSystem fileSystem,
 @NonNull SourceType sourcetype)

JavaModulePathAnalysisInputLocation

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

Creates a JavaModulePathAnalysisInputLocation which locates classes in the given module path.

Parameters:

modulePath - The class path to search in The ClassProvider for generating SootClassSourcees for the files found on the class path

fileSystem - filesystem for the path

Method Details

getModuleInfo

public @NonNull Optional<JavaModuleInfo> getModuleInfo(ModuleSignature sig,
 View view)

Specified by:

getModuleInfo in interface ModuleInfoAnalysisInputLocation

getModules

public @NonNull Set<ModuleSignature> getModules(View view)

Specified by:

getModules in interface ModuleInfoAnalysisInputLocation

getClassSources

public @NonNull Stream<JavaSootClassSource> getClassSources(@NonNull View view)

Description copied from interface: AnalysisInputLocation

Scan the input location and create ClassSources for every compilation / interpretation unit.

Specified by:

getClassSources in interface AnalysisInputLocation

Returns:

an Autocloseable resource that must be closed!

getSourceType

public @NonNull SourceType getSourceType()

Description copied from interface: AnalysisInputLocation

If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType. This is the default implementation and it returns null when no source type is specified.

Specified by:

getSourceType in interface AnalysisInputLocation

Returns:

returns null as source type

getBodyInterceptors

public @NonNull List<BodyInterceptor> getBodyInterceptors()

Specified by:

getBodyInterceptors in interface AnalysisInputLocation

getModulesClassSources

public @NonNull Stream<JavaSootClassSource> getModulesClassSources(@NonNull ModuleSignature moduleSignature,
 @NonNull View view)

Specified by:

getModulesClassSources in interface ModuleInfoAnalysisInputLocation

getClassSourcesInternal

protected Stream<JavaSootClassSource> getClassSourcesInternal(@NonNull ModuleSignature moduleSignature,
 @NonNull View view)

getClassSource

public @NonNull Optional<JavaSootClassSource> getClassSource(@NonNull ClassType classType,
 @NonNull View view)

Description copied from interface: AnalysisInputLocation

Create or find a class source for a given type.

Specified by:

getClassSource in interface AnalysisInputLocation

Parameters:

classType - The type of the class to be found.

Returns:

The source entry for that class.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object