sootup.java.core

Class OverridingJavaClassSource

java.lang.Object

sootup.core.frontend.AbstractClassSource<S>

sootup.core.frontend.SootClassSource<JavaSootClass>

sootup.java.core.JavaSootClassSource

sootup.java.core.OverridingJavaClassSource

public class OverridingJavaClassSource
extends JavaSootClassSource

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 OverridingJavaClassSource. 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 and Description
OverridingJavaClassSource(AnalysisInputLocation<JavaSootClass> srcNamespace, Path sourcePath, ClassType classType, ClassType superClass, Set<ClassType> interfaces, ClassType outerClass, Set<SootField> sootFields, Set<SootMethod> sootMethods, Position position, EnumSet<Modifier> modifiers, Iterable<AnnotationUsage> annotations, Iterable<AnnotationUsage> methodAnnotations, Iterable<AnnotationUsage> fieldAnnotations) Class source where all information already available
OverridingJavaClassSource(JavaSootClassSource delegate)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
protected Iterable<AnnotationUsage>	resolveAnnotations()
Collection<? extends SootField>	resolveFields()
Set<? extends ClassType>	resolveInterfaces()
Collection<? extends SootMethod>	resolveMethods()
Set<Modifier>	resolveModifiers()
Optional<? extends ClassType>	resolveOuterClass()
Position	resolvePosition()
Optional<? extends ClassType>	resolveSuperclass()
String	toString()
OverridingJavaClassSource	withFields(Collection<SootField> overriddenSootFields)
OverridingJavaClassSource	withInterfaces(Set<ClassType> overriddenInterfaces)
OverridingJavaClassSource	withMethods(Collection<SootMethod> overriddenSootMethods)
OverridingJavaClassSource	withModifiers(Set<Modifier> overriddenModifiers)
OverridingJavaClassSource	withOuterClass(Optional<ClassType> overriddenOuterClass)
OverridingJavaClassSource	withPosition(Position position)
OverridingJavaClassSource	withReplacedField(SootField toReplace, SootField replacement)
OverridingJavaClassSource	withReplacedMethod(SootMethod toReplace, SootMethod replacement)
OverridingJavaClassSource	withSuperclass(Optional<ClassType> overriddenSuperclass)

Methods inherited from class sootup.java.core.JavaSootClassSource

buildClass

Methods inherited from class sootup.core.frontend.AbstractClassSource

getClassSource, getClassType, getSourcePath

Methods inherited from class java.lang.Object

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

Constructor Detail

OverridingJavaClassSource

public OverridingJavaClassSource(@Nonnull
                                 JavaSootClassSource delegate)

OverridingJavaClassSource

public OverridingJavaClassSource(@Nonnull
                                 AnalysisInputLocation<JavaSootClass> srcNamespace,
                                 @Nonnull
                                 Path sourcePath,
                                 @Nonnull
                                 ClassType classType,
                                 @Nullable
                                 ClassType superClass,
                                 @Nonnull
                                 Set<ClassType> interfaces,
                                 @Nullable
                                 ClassType outerClass,
                                 @Nonnull
                                 Set<SootField> sootFields,
                                 @Nonnull
                                 Set<SootMethod> sootMethods,
                                 @Nonnull
                                 Position position,
                                 @Nonnull
                                 EnumSet<Modifier> modifiers,
                                 @Nonnull
                                 Iterable<AnnotationUsage> annotations,
                                 @Nonnull
                                 Iterable<AnnotationUsage> methodAnnotations,
                                 @Nullable
                                 Iterable<AnnotationUsage> fieldAnnotations)

Class source where all information already available

Method Detail

resolveMethods

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

Specified by:

resolveMethods in class SootClassSource<JavaSootClass>

Throws:

ResolveException

resolveFields

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

Specified by:

resolveFields in class SootClassSource<JavaSootClass>

Throws:

ResolveException

resolveModifiers

@Nonnull
public Set<Modifier> resolveModifiers()

Specified by:

resolveModifiers in class SootClassSource<JavaSootClass>

resolveInterfaces

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

Specified by:

resolveInterfaces in class SootClassSource<JavaSootClass>

resolveSuperclass

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

Specified by:

resolveSuperclass in class SootClassSource<JavaSootClass>

resolveOuterClass

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

Specified by:

resolveOuterClass in class SootClassSource<JavaSootClass>

resolvePosition

@Nonnull
public Position resolvePosition()

Specified by:

resolvePosition in class SootClassSource<JavaSootClass>

resolveAnnotations

@Nonnull
protected Iterable<AnnotationUsage> resolveAnnotations()

Specified by:

resolveAnnotations in class JavaSootClassSource

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractClassSource<JavaSootClass>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractClassSource<JavaSootClass>

toString

public String toString()

Overrides:

toString in class Object

withReplacedMethod

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

withMethods

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

withReplacedField

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

withFields

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

withModifiers

@Nonnull
public OverridingJavaClassSource withModifiers(@Nonnull
                                                        Set<Modifier> overriddenModifiers)

withInterfaces

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

withSuperclass

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

withOuterClass

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

withPosition

@Nonnull
public OverridingJavaClassSource withPosition(@Nullable
                                                       Position position)