Package sootup.java.frontend.inputlocation

Class JavaSourcePathAnalysisInputLocation

java.lang.Object

sootup.java.frontend.inputlocation.JavaSourcePathAnalysisInputLocation

All Implemented Interfaces:

AnalysisInputLocation

public class JavaSourcePathAnalysisInputLocation
extends Object
implements AnalysisInputLocation

An implementation of the AnalysisInputLocation interface for the Java source code path.

Author:

Linghui Luo

Constructor Summary

Constructors

Constructor	Description
JavaSourcePathAnalysisInputLocation(String sourcePath)
JavaSourcePathAnalysisInputLocation(Set<String> sourcePaths)	Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.
JavaSourcePathAnalysisInputLocation(Set<String> sourcePaths, String exclusionFilePath)	Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.
JavaSourcePathAnalysisInputLocation(SourceType srcType, String sourcePath)	Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.
JavaSourcePathAnalysisInputLocation(SourceType srcType, Set<String> sourcePaths)	Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.
JavaSourcePathAnalysisInputLocation(SourceType srcType, Set<String> sourcePaths, String exclusionFilePath, List<BodyInterceptor> bodyInterceptors)	Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<BodyInterceptor>	getBodyInterceptors()
Optional<JavaSootClassSource>	getClassSource(ClassType type, View view)	Create or find a class source for a given type.
Collection<JavaSootClassSource>	getClassSources(View view)	Scan the input location and create ClassSources for every compilation / interpretation unit.
String	getExclusionFilePath()
SourceType	getSourceType()	If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType.
int	hashCode()
void	setSpecifiedAsBuiltInByUser(SourceType srcType)	The method sets the value of the variable srcType.

Methods inherited from class java.lang.Object

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

Constructor Details

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nonnull
 Set<String> sourcePaths)

Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Parameters:

sourcePaths - the source code path to search in

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nonnull
 String sourcePath)

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nonnull
 Set<String> sourcePaths,
 @Nullable
 String exclusionFilePath)

Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Parameters:

sourcePaths - the source code path to search in

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nullable
 SourceType srcType,
 @Nonnull
 Set<String> sourcePaths)

Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Parameters:

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

sourcePaths - the source code path to search in

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nonnull
 SourceType srcType,
 @Nonnull
 String sourcePath)

Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Parameters:

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

sourcePath - the source code path to search in

JavaSourcePathAnalysisInputLocation

public JavaSourcePathAnalysisInputLocation(@Nullable
 SourceType srcType,
 @Nonnull
 Set<String> sourcePaths,
 @Nullable
 String exclusionFilePath,
 @Nonnull
 List<BodyInterceptor> bodyInterceptors)

Create a JavaSourcePathAnalysisInputLocation which locates java source code in the given source path.

Parameters:

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

sourcePaths - the source code path to search in

Method Details

setSpecifiedAsBuiltInByUser

public void setSpecifiedAsBuiltInByUser(@Nullable
 SourceType srcType)

The method sets the value of the variable srcType.

Parameters:

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

getSourceType

@Nonnull
public 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

@Nonnull
public List<BodyInterceptor> getBodyInterceptors()

Specified by:

getBodyInterceptors in interface AnalysisInputLocation

getClassSources

@Nonnull
public Collection<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:

The source entries.

getClassSource

@Nonnull
public 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.

getExclusionFilePath

public String getExclusionFilePath()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object