Package sootup.java.core

Class OverridingJavaClassSource

java.lang.Object

sootup.core.frontend.AbstractClassSource

sootup.core.frontend.SootClassSource

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	Description
OverridingJavaClassSource(AnalysisInputLocation srcNamespace, Path sourcePath, JavaClassType classType, JavaClassType superClass, Set<JavaClassType> interfaces, JavaClassType outerClass, Set<JavaSootField> sootFields, Set<JavaSootMethod> sootMethods, Position position, EnumSet<ClassModifier> 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	Description
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()
protected Iterable<AnnotationUsage>	resolveAnnotations()
Collection<JavaSootField>	resolveFields()	Reads from the source to retrieve its fields.
Set<ClassType>	resolveInterfaces()	Reads from the source to retrieve its directly implemented interfaces.
Collection<JavaSootMethod>	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()
OverridingJavaClassSource	withFields(Collection<JavaSootField> overriddenSootFields)
OverridingJavaClassSource	withInterfaces(Set<JavaClassType> overriddenInterfaces)
OverridingJavaClassSource	withMethods(Collection<JavaSootMethod> overriddenSootMethods)
OverridingJavaClassSource	withModifiers(Set<ClassModifier> overriddenModifiers)
OverridingJavaClassSource	withOuterClass(Optional<JavaClassType> overriddenOuterClass)
OverridingJavaClassSource	withPosition(Position position)
OverridingJavaClassSource	withReplacedField(JavaSootField toReplace, JavaSootField replacement)
OverridingJavaClassSource	withReplacedMethod(JavaSootMethod toReplace, JavaSootMethod replacement)
OverridingJavaClassSource	withSuperclass(Optional<JavaClassType> overriddenSuperclass)

Methods inherited from class sootup.java.core.JavaSootClassSource

buildClass

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

OverridingJavaClassSource

public OverridingJavaClassSource(@Nonnull
 JavaSootClassSource delegate)

OverridingJavaClassSource

public OverridingJavaClassSource(@Nonnull
 AnalysisInputLocation srcNamespace,
 @Nonnull
 Path sourcePath,
 @Nonnull
 JavaClassType classType,
 @Nullable
 JavaClassType superClass,
 @Nonnull
 Set<JavaClassType> interfaces,
 @Nullable
 JavaClassType outerClass,
 @Nonnull
 Set<JavaSootField> sootFields,
 @Nonnull
 Set<JavaSootMethod> sootMethods,
 @Nonnull
 Position position,
 @Nonnull
 EnumSet<ClassModifier> modifiers,
 @Nonnull
 Iterable<AnnotationUsage> annotations,
 @Nonnull
 Iterable<AnnotationUsage> methodAnnotations,
 @Nullable
 Iterable<AnnotationUsage> fieldAnnotations)

Class source where all information already available

Method Details

resolveMethods

@Nonnull
public Collection<JavaSootMethod> 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<JavaSootField> 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

resolveAnnotations

@Nonnull
protected Iterable<AnnotationUsage> resolveAnnotations()

Specified by:

resolveAnnotations in class JavaSootClassSource

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 OverridingJavaClassSource withReplacedMethod(@Nonnull
 JavaSootMethod toReplace,
 @Nonnull
 JavaSootMethod replacement)

withMethods

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

withReplacedField

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

withFields

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

withModifiers

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

withInterfaces

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

withSuperclass

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

withOuterClass

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

withPosition

@Nonnull
public OverridingJavaClassSource withPosition(@Nullable
 Position position)