Package sootup.java.core

Class OverridingJavaClassSource

java.lang.Object

sootup.java.core.JavaSootClassSource

sootup.java.core.OverridingJavaClassSource

All Implemented Interfaces:

SootClassSource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OverridingJavaClassSource.OverridingJavaClassSourceBuilder	Defines a OverridingJavaClassSource.OverridingJavaClassSourceBuilder builder.

Field Summary

Fields inherited from class sootup.java.core.JavaSootClassSource

analysisInputLocation, classSignature, sourcePath

Constructor Summary

Constructors

Constructor	Description
OverridingJavaClassSource(@NonNull Set<JavaSootMethod> sootMethods, @NonNull Set<JavaSootField> sootFields, @NonNull EnumSet<ClassModifier> modifiers, @NonNull Set<JavaClassType> interfaces, @NonNull JavaClassType superClass, @NonNull JavaClassType outerClass, @NonNull Position position, @NonNull Path sourcePath, @NonNull ClassType classType, @NonNull AnalysisInputLocation srcNamespace)
OverridingJavaClassSource(@NonNull AnalysisInputLocation srcNamespace, @NonNull Path sourcePath, @NonNull ClassType 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
OverridingJavaClassSource(@NonNull 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 @NonNull Iterable<AnnotationUsage>	resolveAnnotations()
@NonNull Collection<JavaSootField>	resolveFields()	Reads from the source to retrieve its fields.
@NonNull Set<ClassType>	resolveInterfaces()	Reads from the source to retrieve its directly implemented interfaces.
@NonNull Collection<JavaSootMethod>	resolveMethods()	Reads from the source to retrieve its methods.
@NonNull Set<ClassModifier>	resolveModifiers()	Reads from the source to retrieve its modifiers.
@NonNull Optional<ClassType>	resolveOuterClass()	Reads from the source to retrieve its outer class, if this is an inner class.
@NonNull Position	resolvePosition()	Reads from the source to retrieve its position in the source code.
@NonNull Optional<ClassType>	resolveSuperclass()	Reads from the source to retrieve its superclass, if present.
String	toString()
@NonNull OverridingJavaClassSource	withFields(@NonNull Collection<JavaSootField> overriddenSootFields)
@NonNull OverridingJavaClassSource	withInterfaces(@NonNull Set<JavaClassType> overriddenInterfaces)
@NonNull OverridingJavaClassSource	withMethods(@NonNull Collection<JavaSootMethod> overriddenSootMethods)
@NonNull OverridingJavaClassSource	withModifiers(@NonNull Set<ClassModifier> overriddenModifiers)
@NonNull OverridingJavaClassSource	withOuterClass(@NonNull Optional<JavaClassType> overriddenOuterClass)
@NonNull OverridingJavaClassSource	withPosition(@Nullable Position position)
@NonNull OverridingJavaClassSource	withReplacedField(@NonNull JavaSootField toReplace, @NonNull JavaSootField replacement)
@NonNull OverridingJavaClassSource	withReplacedMethod(@NonNull JavaSootMethod toReplace, @NonNull JavaSootMethod replacement)
@NonNull OverridingJavaClassSource	withSuperclass(@NonNull Optional<JavaClassType> overriddenSuperclass)

Methods inherited from class sootup.java.core.JavaSootClassSource

buildClass, 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 ClassType 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

OverridingJavaClassSource

public OverridingJavaClassSource(@NonNull Set<JavaSootMethod> sootMethods,
 @NonNull Set<JavaSootField> sootFields,
 @NonNull EnumSet<ClassModifier> modifiers,
 @NonNull Set<JavaClassType> interfaces,
 @NonNull JavaClassType superClass,
 @NonNull JavaClassType outerClass,
 @NonNull Position position,
 @NonNull Path sourcePath,
 @NonNull ClassType classType,
 @NonNull AnalysisInputLocation srcNamespace)

Method Details

resolveMethods

public @NonNull Collection<JavaSootMethod> resolveMethods()
                                                   throws ResolveException

Description copied from interface: SootClassSource

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

Throws:

ResolveException

resolveFields

public @NonNull Collection<JavaSootField> resolveFields()
                                                 throws ResolveException

Description copied from interface: SootClassSource

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

Throws:

ResolveException

resolveModifiers

public @NonNull Set<ClassModifier> resolveModifiers()

Description copied from interface: SootClassSource

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

resolveInterfaces

public @NonNull Set<ClassType> resolveInterfaces()

Description copied from interface: SootClassSource

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

resolveSuperclass

public @NonNull Optional<ClassType> resolveSuperclass()

Description copied from interface: SootClassSource

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

resolveOuterClass

public @NonNull Optional<ClassType> resolveOuterClass()

Description copied from interface: SootClassSource

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

Returns:

resolvePosition

public @NonNull Position resolvePosition()

Description copied from interface: SootClassSource

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

resolveAnnotations

protected @NonNull Iterable<AnnotationUsage> resolveAnnotations()

Specified by:

resolveAnnotations in class JavaSootClassSource

equals

public boolean equals(Object o)

Description copied from class: JavaSootClassSource

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 JavaSootClassSource

Parameters:

o - the object to compare with

Returns:

both objects are logically equal

hashCode

public int hashCode()

Overrides:

hashCode in class JavaSootClassSource

toString

public String toString()

Overrides:

toString in class Object

withReplacedMethod

public @NonNull OverridingJavaClassSource withReplacedMethod(@NonNull JavaSootMethod toReplace,
 @NonNull JavaSootMethod replacement)

withMethods

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

withReplacedField

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

withFields

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

withModifiers

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

withInterfaces

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

withSuperclass

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

withOuterClass

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

withPosition

public @NonNull OverridingJavaClassSource withPosition(@Nullable Position position)