Package sootup.core.frontend

Class SootClassSource

java.lang.Object

sootup.core.frontend.AbstractClassSource

sootup.core.frontend.SootClassSource

Direct Known Subclasses:

JavaSootClassSource, OverridingClassSource

public abstract class SootClassSource
extends AbstractClassSource

Basic class for retrieving information that is needed to build a SootClass.

Author:

Manuel Benz created on 22.05.18, Ben Hermann, Linghui Luo

Field Summary

Fields inherited from class sootup.core.frontend.AbstractClassSource

classSignature, classSource, sourcePath

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SootClassSource(SootClassSource delegate)
	SootClassSource(AnalysisInputLocation srcNamespace, ClassType classSignature, Path sourcePath)	Creates and a SootClassSource for a specific source file.

Method Summary

Modifier and Type	Method	Description
abstract Collection<? extends SootField>	resolveFields()	Reads from the source to retrieve its fields.
abstract Set<? extends ClassType>	resolveInterfaces()	Reads from the source to retrieve its directly implemented interfaces.
abstract Collection<? extends SootMethod>	resolveMethods()	Reads from the source to retrieve its methods.
abstract Set<ClassModifier>	resolveModifiers()	Reads from the source to retrieve its modifiers.
abstract Optional<? extends ClassType>	resolveOuterClass()	Reads from the source to retrieve its outer class, if this is an inner class.
abstract Position	resolvePosition()	Reads from the source to retrieve its position in the source code.
abstract Optional<? extends ClassType>	resolveSuperclass()	Reads from the source to retrieve its superclass, if present.

Methods inherited from class sootup.core.frontend.AbstractClassSource

buildClass, equals, getAnalysisInputLocation, getClassType, getSourcePath, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

SootClassSource

public SootClassSource(@Nonnull
 AnalysisInputLocation srcNamespace,
 @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...) to access the file.

Parameters:

srcNamespace - 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 ClassProvider. Implementations might double check this if wanted.

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

SootClassSource

protected SootClassSource(SootClassSource delegate)

Method Details

resolveMethods

@Nonnull
public abstract Collection<? extends SootMethod> resolveMethods()
                                                         throws ResolveException

Reads from the source to retrieve its methods. This may be an expensive operation.

Throws:

ResolveException

resolveFields

@Nonnull
public abstract Collection<? extends SootField> resolveFields()
                                                       throws ResolveException

Reads from the source to retrieve its fields. This may be an expensive operation.

Throws:

ResolveException

resolveModifiers

@Nonnull
public abstract Set<ClassModifier> resolveModifiers()

Reads from the source to retrieve its modifiers. This may be an expensive operation.

resolveInterfaces

@Nonnull
public abstract Set<? extends ClassType> resolveInterfaces()

Reads from the source to retrieve its directly implemented interfaces. This may be an expensive operation.

resolveSuperclass

@Nonnull
public abstract Optional<? extends ClassType> resolveSuperclass()

Reads from the source to retrieve its superclass, if present. This may be an expensive operation.

resolveOuterClass

@Nonnull
public abstract Optional<? extends ClassType> resolveOuterClass()

Reads from the source to retrieve its outer class, if this is an inner class. This may be an expensive operation.

Returns:

resolvePosition

@Nonnull
public abstract Position resolvePosition()

Reads from the source to retrieve its position in the source code. This may be an expensive operation.