Package sootup.java.bytecode.frontend.inputlocation

Class PathBasedAnalysisInputLocation

java.lang.Object

sootup.java.bytecode.frontend.inputlocation.PathBasedAnalysisInputLocation

All Implemented Interfaces:

AnalysisInputLocation

Direct Known Subclasses:

ArchiveBasedAnalysisInputLocation, PathBasedAnalysisInputLocation.ClassFileBasedAnalysisInputLocation

public abstract class PathBasedAnalysisInputLocation
extends Object
implements AnalysisInputLocation

Base class for PathBasedAnalysisInputLocations that can be located by a Path object.

Author:

Manuel Benz created on 22.05.18, Kaustubh Kelkar updated on 30.07.2020

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathBasedAnalysisInputLocation.ClassFileBasedAnalysisInputLocation

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<BodyInterceptor>	bodyInterceptors
protected Collection<Path>	ignoredPaths
protected Path	path
protected final SourceType	sourceType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathBasedAnalysisInputLocation(Path path, SourceType srcType)
protected	PathBasedAnalysisInputLocation(Path path, SourceType srcType, List<BodyInterceptor> bodyInterceptors)
protected	PathBasedAnalysisInputLocation(Path path, SourceType srcType, List<BodyInterceptor> bodyInterceptors, Collection<Path> ignoredPaths)

Method Summary

Modifier and Type	Method	Description
static PathBasedAnalysisInputLocation	create(Path path, SourceType sourceType)
static PathBasedAnalysisInputLocation	create(Path path, SourceType srcType, List<BodyInterceptor> bodyInterceptors)
static PathBasedAnalysisInputLocation	create(Path path, SourceType srcType, List<BodyInterceptor> bodyInterceptors, Collection<Path> ignoredPaths)
protected String	fromPath(Path baseDirPath, Path packageNamePathAndClass)
List<BodyInterceptor>	getBodyInterceptors()
protected Optional<JavaSootClassSource>	getClassSourceInternal(JavaClassType signature, Path path, ClassProvider classProvider)
protected Optional<JavaSootClassSource>	getSingleClass(JavaClassType signature, Path path, ClassProvider classProvider)
SourceType	getSourceType()	If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sootup.core.inputlocation.AnalysisInputLocation

getClassSource, getClassSources

Field Details

path

@Nonnull
protected Path path

ignoredPaths

@Nonnull
protected Collection<Path> ignoredPaths

sourceType

@Nonnull
protected final SourceType sourceType

bodyInterceptors

@Nonnull
protected final List<BodyInterceptor> bodyInterceptors

Constructor Details

PathBasedAnalysisInputLocation

protected PathBasedAnalysisInputLocation(@Nonnull
 Path path,
 @Nonnull
 SourceType srcType)

PathBasedAnalysisInputLocation

protected PathBasedAnalysisInputLocation(@Nonnull
 Path path,
 @Nonnull
 SourceType srcType,
 @Nonnull
 List<BodyInterceptor> bodyInterceptors)

PathBasedAnalysisInputLocation

protected PathBasedAnalysisInputLocation(@Nonnull
 Path path,
 @Nonnull
 SourceType srcType,
 @Nonnull
 List<BodyInterceptor> bodyInterceptors,
 @Nonnull
 Collection<Path> ignoredPaths)

Method Details

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

create

@Nonnull
public static PathBasedAnalysisInputLocation create(@Nonnull
 Path path,
 @Nonnull
 SourceType sourceType)

create

@Nonnull
public static PathBasedAnalysisInputLocation create(@Nonnull
 Path path,
 @Nonnull
 SourceType srcType,
 @Nonnull
 List<BodyInterceptor> bodyInterceptors)

create

@Nonnull
public static PathBasedAnalysisInputLocation create(@Nonnull
 Path path,
 @Nonnull
 SourceType srcType,
 @Nonnull
 List<BodyInterceptor> bodyInterceptors,
 @Nonnull
 Collection<Path> ignoredPaths)

fromPath

@Nonnull
protected String fromPath(@Nonnull
 Path baseDirPath,
 Path packageNamePathAndClass)

getClassSourceInternal

@Nonnull
protected Optional<JavaSootClassSource> getClassSourceInternal(@Nonnull
 JavaClassType signature,
 @Nonnull
 Path path,
 @Nonnull
 ClassProvider classProvider)

getSingleClass

protected Optional<JavaSootClassSource> getSingleClass(@Nonnull
 JavaClassType signature,
 @Nonnull
 Path path,
 @Nonnull
 ClassProvider classProvider)