Package sootup.java.core

Class JavaSootClassSource

java.lang.Object

sootup.java.core.JavaSootClassSource

All Implemented Interfaces:

SootClassSource, HasGenericSignature

Direct Known Subclasses:

AsmAnnotationClassSource, DexClassSource, InMemoryJavaClassSource, OverridingJavaClassSource

public abstract class JavaSootClassSource
extends Object
implements SootClassSource, HasGenericSignature

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnalysisInputLocation	analysisInputLocation
protected ClassType	classSignature
protected final Path	sourcePath

Constructor Summary

Constructors

Constructor	Description
JavaSootClassSource(@NonNull AnalysisInputLocation inputLocation, @NonNull ClassType classSignature, @NonNull Path sourcePath)	Creates and a SootClassSource for a specific source file.
JavaSootClassSource(@NonNull AnalysisInputLocation inputLocation, @NonNull ClassType classSignature, @NonNull Path sourcePath, @NonNull JavaClassFileMetadata classFileMetadata)	Creates a class source with immutable source and nesting attributes.
JavaSootClassSource(SootClassSource delegate)

Method Summary

Modifier and Type	Method	Description
@NonNull JavaSootClass	buildClass(@NonNull SourceType sourceType)
boolean	equals(@Nullable Object o)	Even if a the signature changes, the classource remains the same, e.g., if it is associated to an automatic module s
AnalysisInputLocation	getAnalysisInputLocation()
@NonNull JavaClassFileMetadata	getClassFileMetadata()	Returns immutable source and nesting attributes, empty for sources that do not provide them.
ClassType	getClassType()
@NonNull Optional<String>	getGenericSignature()	Returns the unparsed classfile Signature attribute, or an empty optional if absent.
Path	getSourcePath()
int	hashCode()
protected abstract Iterable<AnnotationUsage>	resolveAnnotations()

Methods inherited from class java.lang.Object

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

Methods inherited from interface sootup.core.frontend.SootClassSource

resolveFields, resolveInterfaces, resolveMethods, resolveModifiers, resolveOuterClass, resolvePosition, resolveSuperclass

Field Details

analysisInputLocation

protected final AnalysisInputLocation analysisInputLocation

classSignature

protected ClassType classSignature

sourcePath

protected final Path sourcePath

Constructor Details

JavaSootClassSource

public JavaSootClassSource(@NonNull AnalysisInputLocation inputLocation,
 @NonNull ClassType classSignature,
 @NonNull Path sourcePath)

Creates and a SootClassSource for a specific source file. The file should be passed as Path and can be located in an arbitrary FileSystem. Implementations should use Files.newInputStream(Path, OpenOption...) (Path, OpenOption...)} to access the file.

Parameters:

inputLocation - The AnalysisInputLocation that holds the given file

sourcePath - Path to the source file of the to-be-created SootClassSource. The given path has to exist and requires to be handled by this PathbasedClassProvider. Implementations might double check this if wanted.

classSignature - the signature that has been used to resolve this class

JavaSootClassSource

public JavaSootClassSource(@NonNull AnalysisInputLocation inputLocation,
 @NonNull ClassType classSignature,
 @NonNull Path sourcePath,
 @NonNull JavaClassFileMetadata classFileMetadata)

Creates a class source with immutable source and nesting attributes.

JavaSootClassSource

public JavaSootClassSource(SootClassSource delegate)

Method Details

getClassFileMetadata

public @NonNull JavaClassFileMetadata getClassFileMetadata()

Returns immutable source and nesting attributes, empty for sources that do not provide them.

getGenericSignature

public @NonNull Optional<String> getGenericSignature()

Returns the unparsed classfile Signature attribute, or an empty optional if absent.

Specified by:

getGenericSignature in interface HasGenericSignature

Returns:

the raw classfile generic signature, or empty if absent

resolveAnnotations

protected abstract Iterable<AnnotationUsage> resolveAnnotations()

buildClass

public @NonNull JavaSootClass buildClass(@NonNull SourceType sourceType)

Specified by:

buildClass in interface SootClassSource

Parameters:

sourceType - instantiates the Subclass of SootClassSource to create a *SootClass

Returns:

a *SootClass

getClassType

public ClassType getClassType()

Specified by:

getClassType in interface SootClassSource

getAnalysisInputLocation

public AnalysisInputLocation getAnalysisInputLocation()

Specified by:

getAnalysisInputLocation in interface SootClassSource

getSourcePath

public Path getSourcePath()

Specified by:

getSourcePath in interface SootClassSource

equals

public boolean equals(@Nullable Object o)

Even if a the signature changes, the classource remains the same, e.g., if it is associated to an automatic module s

Overrides:

equals in class Object

Parameters:

o - the object to compare with

Returns:

both objects are logically equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object