Package sootup.java.core

Class InMemoryJavaClassSource

java.lang.Object

sootup.java.core.JavaSootClassSource

sootup.java.core.InMemoryJavaClassSource

All Implemented Interfaces:

SootClassSource, HasGenericSignature

public class InMemoryJavaClassSource
extends JavaSootClassSource

A class source where all information is already available in memory, e.g. classes that are batchparsed (like .jimple files) or synthesized in tests.

To replace parts of an existing class source, wrap it in an OverridingJavaClassSource.

Author:

Christian Brüggemann, Hasitha Rajapakse, Ashik Mogasavara Ravikumar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InMemoryJavaClassSource.AnalysisInputLocationStep
static interface	InMemoryJavaClassSource.ClassTypeStep
static interface	InMemoryJavaClassSource.OptionalStep	Optional parts; every part that is not set defaults to absent/empty.

Field Summary

Fields inherited from class sootup.java.core.JavaSootClassSource

analysisInputLocation, classSignature, sourcePath

Constructor Summary

Constructors

Constructor	Description
InMemoryJavaClassSource(@NonNull Set<JavaSootMethod> sootMethods, @NonNull Set<JavaSootField> sootFields, @NonNull EnumSet<ClassModifier> modifiers, @NonNull Set<JavaClassType> interfaces, @Nullable JavaClassType superClass, @Nullable JavaClassType outerClass, @NonNull Position position, @NonNull Path sourcePath, @NonNull ClassType classType, @NonNull AnalysisInputLocation inputLocation)
InMemoryJavaClassSource(@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)
InMemoryJavaClassSource(@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, @NonNull JavaClassFileMetadata classFileMetadata)	Creates a fully resolved class source with immutable source and nesting attributes.

Method Summary

Modifier and Type	Method	Description
static @NonNull InMemoryJavaClassSource.AnalysisInputLocationStep	builder()	Starts a stepwise builder: the input location and the class type are mandatory.
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()
@NonNull Iterable<AnnotationUsage>	resolveAnnotations()
@NonNull Collection<? extends SootField>	resolveFields()	Reads from the source to retrieve its fields.
@NonNull Set<? extends ClassType>	resolveInterfaces()	Reads from the source to retrieve its directly implemented interfaces.
@NonNull Collection<? extends SootMethod>	resolveMethods()	Reads from the source to retrieve its methods.
@NonNull Set<ClassModifier>	resolveModifiers()	Reads from the source to retrieve its modifiers.
@NonNull Optional<? extends 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<? extends ClassType>	resolveSuperclass()	Reads from the source to retrieve its superclass, if present.
String	toString()

Methods inherited from class sootup.java.core.JavaSootClassSource

buildClass, getAnalysisInputLocation, getClassFileMetadata, getClassType, getGenericSignature, getSourcePath

Methods inherited from class java.lang.Object

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

Constructor Details

InMemoryJavaClassSource

public InMemoryJavaClassSource(@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)

InMemoryJavaClassSource

public InMemoryJavaClassSource(@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,
 @NonNull JavaClassFileMetadata classFileMetadata)

Creates a fully resolved class source with immutable source and nesting attributes.

Parameters:

srcNamespace - the input location containing the class

sourcePath - the path to the classfile

classType - the class type

superClass - the superclass, or null if absent

interfaces - the implemented interfaces

outerClass - the outer class, or null if absent

sootFields - the fields

sootMethods - the methods

position - the source position

modifiers - the class modifiers

annotations - the class annotations

methodAnnotations - the method annotations

fieldAnnotations - the field annotations

classFileMetadata - the source and nesting attributes

InMemoryJavaClassSource

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

Method Details

resolveMethods

public @NonNull Collection<? extends SootMethod> resolveMethods()

Description copied from interface: SootClassSource

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

resolveFields

public @NonNull Collection<? extends SootField> resolveFields()

Description copied from interface: SootClassSource

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

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<? extends 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<? extends 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<? extends 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

public @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

builder

public static @NonNull InMemoryJavaClassSource.AnalysisInputLocationStep builder()

Starts a stepwise builder: the input location and the class type are mandatory.