Package sootup.core.frontend

Class OverridingClassSource

java.lang.Object

sootup.core.frontend.AbstractClassSource

sootup.core.frontend.SootClassSource

sootup.core.frontend.OverridingClassSource

public class OverridingClassSource
extends SootClassSource

Allows for replacing specific parts of a class, such as fields and methods or, allows to resolve classes that are batchparsed like .java files using wala java source frontend or in tests where all information is already existing.

When replacing specific parts of a class by default, it delegates to the SootClassSource delegate provided in the constructor.

To alter the results of invocations to e.g. resolveFields(), simply call withFields(Collection) to obtain a new OverridingClassSource. The new instance will then use the supplied value instead of calling resolveFields() on the delegate.

Author:

Christian Brüggemann, Hasitha Rajapakse

Field Summary

Fields inherited from class sootup.core.frontend.AbstractClassSource

classSignature, classSource, sourcePath

Constructor Summary

Constructors

Constructor	Description
OverridingClassSource(Set<SootMethod> sootMethods, Set<SootField> sootFields, EnumSet<ClassModifier> modifiers, Set<ClassType> interfaces, ClassType superClass, ClassType outerClass, Position position, Path sourcePath, ClassType classType, AnalysisInputLocation srcNamespace)	Class source where all information already available
OverridingClassSource(SootClassSource delegate)

Method Summary

Modifier and Type	Method	Description
SootClass	buildClass(SourceType sourceType)
boolean	equals(Object o)	Even if a the signature changes, the classource remains the same, e.g., if it is associated to an automatic module s
int	hashCode()
Collection<SootField>	resolveFields()	Reads from the source to retrieve its fields.
Set<ClassType>	resolveInterfaces()	Reads from the source to retrieve its directly implemented interfaces.
Collection<SootMethod>	resolveMethods()	Reads from the source to retrieve its methods.
Set<ClassModifier>	resolveModifiers()	Reads from the source to retrieve its modifiers.
Optional<ClassType>	resolveOuterClass()	Reads from the source to retrieve its outer class, if this is an inner class.
Position	resolvePosition()	Reads from the source to retrieve its position in the source code.
Optional<ClassType>	resolveSuperclass()	Reads from the source to retrieve its superclass, if present.
String	toString()
OverridingClassSource	withFields(Collection<SootField> overriddenSootFields)
OverridingClassSource	withInterfaces(Set<ClassType> overriddenInterfaces)
OverridingClassSource	withMethods(Collection<SootMethod> overriddenSootMethods)
OverridingClassSource	withModifiers(Set<ClassModifier> overriddenModifiers)
OverridingClassSource	withOuterClass(Optional<ClassType> overriddenOuterClass)
OverridingClassSource	withPosition(Position position)
OverridingClassSource	withReplacedField(SootField toReplace, SootField replacement)
OverridingClassSource	withReplacedMethod(SootMethod toReplace, SootMethod replacement)
OverridingClassSource	withSuperclass(Optional<ClassType> overriddenSuperclass)

Methods inherited from class sootup.core.frontend.AbstractClassSource

getAnalysisInputLocation, getClassType, getSourcePath

Methods inherited from class java.lang.Object

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

Constructor Details

OverridingClassSource

public OverridingClassSource(@Nonnull
 SootClassSource delegate)

OverridingClassSource

public OverridingClassSource(@Nonnull
 Set<SootMethod> sootMethods,
 @Nonnull
 Set<SootField> sootFields,
 @Nonnull
 EnumSet<ClassModifier> modifiers,
 @Nonnull
 Set<ClassType> interfaces,
 @Nonnull
 ClassType superClass,
 @Nonnull
 ClassType outerClass,
 @Nonnull
 Position position,
 @Nonnull
 Path sourcePath,
 @Nonnull
 ClassType classType,
 @Nonnull
 AnalysisInputLocation srcNamespace)

Class source where all information already available

Method Details

resolveMethods

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

Description copied from class: SootClassSource

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

Specified by:

resolveMethods in class SootClassSource

Throws:

ResolveException

resolveFields

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

Description copied from class: SootClassSource

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

Specified by:

resolveFields in class SootClassSource

Throws:

ResolveException

resolveModifiers

@Nonnull
public Set<ClassModifier> resolveModifiers()

Description copied from class: SootClassSource

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

Specified by:

resolveModifiers in class SootClassSource

resolveInterfaces

@Nonnull
public Set<ClassType> resolveInterfaces()

Description copied from class: SootClassSource

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

Specified by:

resolveInterfaces in class SootClassSource

resolveSuperclass

@Nonnull
public Optional<ClassType> resolveSuperclass()

Description copied from class: SootClassSource

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

Specified by:

resolveSuperclass in class SootClassSource

resolveOuterClass

@Nonnull
public Optional<ClassType> resolveOuterClass()

Description copied from class: SootClassSource

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

Specified by:

resolveOuterClass in class SootClassSource

Returns:

resolvePosition

@Nonnull
public Position resolvePosition()

Description copied from class: SootClassSource

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

Specified by:

resolvePosition in class SootClassSource

buildClass

public SootClass buildClass(@Nonnull
 SourceType sourceType)

Specified by:

buildClass in class AbstractClassSource

Parameters:

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

Returns:

a *SootClass

equals

public boolean equals(Object o)

Description copied from class: AbstractClassSource

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 AbstractClassSource

Parameters:

o - the object to compare with

Returns:

both objects are logically equal

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractClassSource

toString

public String toString()

Overrides:

toString in class Object

withReplacedMethod

@Nonnull
public OverridingClassSource withReplacedMethod(@Nonnull
 SootMethod toReplace,
 @Nonnull
 SootMethod replacement)

withMethods

@Nonnull
public OverridingClassSource withMethods(@Nonnull
 Collection<SootMethod> overriddenSootMethods)

withReplacedField

@Nonnull
public OverridingClassSource withReplacedField(@Nonnull
 SootField toReplace,
 @Nonnull
 SootField replacement)

withFields

@Nonnull
public OverridingClassSource withFields(@Nonnull
 Collection<SootField> overriddenSootFields)

withModifiers

@Nonnull
public OverridingClassSource withModifiers(@Nonnull
 Set<ClassModifier> overriddenModifiers)

withInterfaces

@Nonnull
public OverridingClassSource withInterfaces(@Nonnull
 Set<ClassType> overriddenInterfaces)

withSuperclass

@Nonnull
public OverridingClassSource withSuperclass(@Nonnull
 Optional<ClassType> overriddenSuperclass)

withOuterClass

@Nonnull
public OverridingClassSource withOuterClass(@Nonnull
 Optional<ClassType> overriddenOuterClass)

withPosition

@Nonnull
public OverridingClassSource withPosition(@Nullable
 Position position)