Package sootup.java.bytecode.frontend.inputlocation

Class JavaClassPathAnalysisInputLocation

java.lang.Object

sootup.java.bytecode.frontend.inputlocation.JavaClassPathAnalysisInputLocation

All Implemented Interfaces:

AnalysisInputLocation

public class JavaClassPathAnalysisInputLocation
extends Object
implements AnalysisInputLocation

An implementation of the AnalysisInputLocation interface for the Java class path. Handles directories, archives (including wildcard denoted archives) as stated in the official documentation: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/classpath.html

Author:

Manuel Benz created on 22.05.18, Kaustubh Kelkar updated on 20.07.2020

Constructor Summary

Constructors

Constructor	Description
JavaClassPathAnalysisInputLocation(@NonNull String classPath)	Creates a JavaClassPathAnalysisInputLocation which locates classes in the given class path.
JavaClassPathAnalysisInputLocation(@NonNull String classPath, @NonNull SourceType srcType)
JavaClassPathAnalysisInputLocation(@NonNull String classPath, @NonNull SourceType srcType, @NonNull List<BodyInterceptor> bodyInterceptors)	Creates a JavaClassPathAnalysisInputLocation which locates classes in the given class path.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull List<BodyInterceptor>	getBodyInterceptors()
@NonNull Optional<JavaSootClassSource>	getClassSource(@NonNull ClassType type, @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.
@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

JavaClassPathAnalysisInputLocation

public JavaClassPathAnalysisInputLocation(@NonNull String classPath)

Creates a JavaClassPathAnalysisInputLocation which locates classes in the given class path.

Parameters:

classPath - The class path to search in

JavaClassPathAnalysisInputLocation

public JavaClassPathAnalysisInputLocation(@NonNull String classPath,
 @NonNull SourceType srcType)

JavaClassPathAnalysisInputLocation

public JavaClassPathAnalysisInputLocation(@NonNull String classPath,
 @NonNull SourceType srcType,
 @NonNull List<BodyInterceptor> bodyInterceptors)

Creates a JavaClassPathAnalysisInputLocation which locates classes in the given class path.

Parameters:

classPath - the class path to search in

srcType - the source type for the path can be Library, Application, Phantom.

Method Details

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

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!

getClassSource

public @NonNull Optional<JavaSootClassSource> getClassSource(@NonNull ClassType type,
 @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:

type - 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