Scene (Soot - a J*va Optimization Framework 3.2.0 API)

java.lang.Object
- soot.Scene

```
public class Scene
extends Object
```
Manages the SootClasses of the application being analyzed.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClientAccessibilityOracle`	`accessibilityOracle`
`protected CallGraph`	`activeCallGraph`
`protected FastHierarchy`	`activeFastHierarchy`
`protected Hierarchy`	`activeHierarchy`
`protected PointsToAnalysis`	`activePointsToAnalysis`
`protected SideEffectAnalysis`	`activeSideEffectAnalysis`
`protected boolean`	`allowsPhantomRefs`
`protected ArrayNumberer<SootClass>`	`classNumberer`
`protected Numberer<Context>`	`contextNumberer`
`protected List<SootMethod>`	`entryPoints`
`protected LinkedList<String>`	`excludedPackages`
`protected Numberer<SparkField>`	`fieldNumberer`
`protected ArrayNumberer<Kind>`	`kindNumberer`
`protected ArrayNumberer<Local>`	`localNumberer`
`protected SootClass`	`mainClass`
`protected ArrayNumberer<SootMethod>`	`methodNumberer`
`protected ReachableMethods`	`reachableMethods`
`protected String`	`sootClassPath`
`protected StringNumberer`	`subSigNumberer`
`protected ArrayNumberer<Type>`	`typeNumberer`
`protected Numberer<Unit>`	`unitNumberer`

Constructor Summary

Constructors
Constructor and Description

Scene(Singletons.Global g)

Constructors
Constructor and Description
`Scene(Singletons.Global g)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBasicClass(String name)`
`void`	`addBasicClass(String name, int level)`
`void`	`addClass(SootClass c)` Adds the given class to the Scene.
`protected void`	`addClassSilent(SootClass c)` Adds the given class to the Scene.
`void`	`addRefType(RefType type)` Returns the RefType with the given className.
`boolean`	`allowsPhantomRefs()`
`boolean`	`containsClass(String className)`
`boolean`	`containsField(String fieldSignature)`
`boolean`	`containsMethod(String methodSignature)`
`boolean`	`containsType(String className)`
`String`	`defaultClassPath()`
`boolean`	`doneResolving()`
`Collection<SootClass>`	`dynamicClasses()`
`void`	`extendSootClassPath(String newPathElement)`
`SootClass`	`forceResolve(String className, int level)`
`Hierarchy`	`getActiveHierarchy()` Retrieves the active hierarchy
`int`	`getAndroidAPIVersion()`
`String`	`getAndroidJarPath(String jars, String apk)`
`Chain<SootClass>`	`getApplicationClasses()` Returns a chain of the application classes in this scene.
`Set<String>`	`getBasicClasses()`
`CallGraph`	`getCallGraph()`
`Chain<SootClass>`	`getClasses()` Returns an backed chain of the classes in this manager.
`List<SootClass>`	`getClasses(int desiredLevel)` Returns the list of SootClasses that have been resolved at least to the level specified.
`ArrayNumberer<SootClass>`	`getClassNumberer()`
`ClientAccessibilityOracle`	`getClientAccessibilityOracle()` Retrieves the active client accessibility oracle
`Numberer<Context>`	`getContextNumberer()`
`ContextSensitiveCallGraph`	`getContextSensitiveCallGraph()`
`ThrowAnalysis`	`getDefaultThrowAnalysis()` Returns the `ThrowAnalysis` to be used by default when constructing CFGs which include exceptional control flow.
`List<SootMethod>`	`getEntryPoints()` Get the set of entry points that are used to build the call graph.
`FastHierarchy`	`getFastHierarchy()` Retrieves the active fast hierarchy
`SootField`	`getField(String fieldSignature)`
`Numberer<SparkField>`	`getFieldNumberer()`
`Chain<SootClass>`	`getLibraryClasses()` Returns a chain of the library classes in this scene.
`ArrayNumberer<Local>`	`getLocalNumberer()`
`SootClass`	`getMainClass()`
`SootMethod`	`getMainMethod()`
`SootMethod`	`getMethod(String methodSignature)`
`ArrayNumberer<SootMethod>`	`getMethodNumberer()`
`RefType`	`getObjectType()` Returns the `RefType` for `Object`.
`RefType`	`getOrAddRefType(RefType tp)`
`FastHierarchy`	`getOrMakeFastHierarchy()` Makes a new fast hierarchy is none is active, and returns the active fast hierarchy.
`Chain<SootClass>`	`getPhantomClasses()` Returns a chain of the phantom classes in this scene.
`boolean`	`getPhantomRefs()`
`List<String>`	`getPkgList()`
`PointsToAnalysis`	`getPointsToAnalysis()` Retrieves the active pointer analysis
`ReachableMethods`	`getReachableMethods()`
`RefType`	`getRefType(String className)` Returns the RefType with the given className.
`RefType`	`getRefTypeUnsafe(String className)` Returns the RefType with the given className.
`Set<String>`	`getReservedNames()` Returns a set of tokens which are reserved.
`SideEffectAnalysis`	`getSideEffectAnalysis()` Retrieves the active side-effect analysis
`SootClass`	`getSootClass(String className)` Returns the SootClass with the given className.
`String`	`getSootClassPath()`
`SootClass`	`getSootClassUnsafe(String className)` Returns the SootClass with the given className.
`SootClass`	`getSootClassUnsafe(String className, boolean phantomNonExist)` Returns the SootClass with the given className.
`int`	`getState()`
`StringNumberer`	`getSubSigNumberer()`
`Type`	`getType(String arg)` Returns the RefType with the given class name or primitive type.
`ArrayNumberer<Type>`	`getTypeNumberer()`
`Type`	`getTypeUnsafe(String arg)` Returns a Type object representing the given type string.
`Type`	`getTypeUnsafe(String arg, boolean phantomNonExist)` Returns a Type object representing the given type string.
`Numberer<Unit>`	`getUnitNumberer()`
`SootField`	`grabField(String fieldSignature)`
`SootMethod`	`grabMethod(String methodSignature)`
`boolean`	`hasActiveHierarchy()`
`boolean`	`hasCallGraph()`
`boolean`	`hasClientAccessibilityOracle()`
`boolean`	`hasCustomEntryPoints()`
`boolean`	`hasFastHierarchy()`
`boolean`	`hasMainClass()`
`boolean`	`hasPointsToAnalysis()`
`boolean`	`hasReachableMethods()`
`boolean`	`hasSideEffectAnalysis()`
`void`	`incrementalBuildFinished()`
`void`	`initiateIncrementalBuild()`
`CallGraph`	`internalMakeCallGraph()` SOOT USERS: DO NOT CALL THIS METHOD!
`static boolean`	`isApk(String file)`
`boolean`	`isExcluded(SootClass sc)`
`boolean`	`isIncluded(SootClass sc)`
`boolean`	`isIncrementalBuild()` This method returns true when in incremental build mode.
`Numberer<Kind>`	`kindNumberer()`
`void`	`loadBasicClasses()` Load just the set of basic classes soot needs, ignoring those specified on the command-line.
`SootClass`	`loadClass(String className, int desiredLevel)`
`SootClass`	`loadClassAndSupport(String className)` Loads the given class and all of the required support classes.
`void`	`loadDynamicClasses()`
`void`	`loadNecessaryClasses()` Load the set of classes that soot needs, including those specified on the command-line.
`SootMethodRef`	`makeConstructorRef(SootClass declaringClass, List<Type> parameterTypes)` Create an unresolved reference to a constructor.
`SootFieldRef`	`makeFieldRef(SootClass declaringClass, String name, Type type, boolean isStatic)` Create an unresolved reference to a field.
`SootMethodRef`	`makeMethodRef(SootClass declaringClass, String name, List<Type> parameterTypes, Type returnType, boolean isStatic)` Create an unresolved reference to a method.
`SootClass`	`makeSootClass(String name)`
`SootClass`	`makeSootClass(String name, int modifiers)`
`SootField`	`makeSootField(String name, Type type)`
`SootField`	`makeSootField(String name, Type type, int modifiers)`
`SootMethod`	`makeSootMethod(String name, List<Type> parameterTypes, Type returnType)`
`SootMethod`	`makeSootMethod(String name, List<Type> parameterTypes, Type returnType, int modifiers)`
`SootMethod`	`makeSootMethod(String name, List<Type> parameterTypes, Type returnType, int modifiers, List<SootClass> thrownExceptions)`
`protected void`	`modifyHierarchy()`
`String`	`quotedNameOf(String s)` If this name is in the set of reserved names, then return a quoted version of it.
`void`	`releaseActiveHierarchy()`
`void`	`releaseCallGraph()`
`void`	`releaseClientAccessibilityOracle()`
`void`	`releaseFastHierarchy()`
`void`	`releasePointsToAnalysis()`
`void`	`releaseReachableMethods()`
`void`	`releaseSideEffectAnalysis()`
`void`	`removeClass(SootClass c)`
`void`	`setActiveHierarchy(Hierarchy hierarchy)` Sets the active hierarchy
`void`	`setCallGraph(CallGraph cg)`
`void`	`setClientAccessibilityOracle(ClientAccessibilityOracle oracle)`
`void`	`setContextNumberer(Numberer<Context> n)`
`void`	`setContextSensitiveCallGraph(ContextSensitiveCallGraph cscg)`
`void`	`setDefaultThrowAnalysis(ThrowAnalysis ta)` Sets the `ThrowAnalysis` to be used by default when constructing CFGs which include exceptional control flow.
`void`	`setDoneResolving()`
`void`	`setEntryPoints(List<SootMethod> entryPoints)` Change the set of entry point methods used to build the call graph.
`void`	`setFastHierarchy(FastHierarchy hierarchy)` Sets the active hierarchy
`void`	`setMainClass(SootClass m)`
`void`	`setMainClassFromOptions()`
`void`	`setPhantomRefs(boolean value)`
`void`	`setPkgList(List<String> list)`
`void`	`setPointsToAnalysis(PointsToAnalysis pa)` Sets the active pointer analysis
`void`	`setReachableMethods(ReachableMethods rm)`
`void`	`setSideEffectAnalysis(SideEffectAnalysis sea)` Sets the active side-effect analysis
`void`	`setSootClassPath(String p)`
`String`	`signatureToClass(String sig)`
`String`	`signatureToSubsignature(String sig)`
`SootClass`	`tryLoadClass(String className, int desiredLevel)` Attempts to load the given class and all of the required support classes.
`String`	`unescapeName(String s)` This method is the inverse of quotedNameOf().
`static Scene`	`v()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kindNumberer

protected final ArrayNumberer<Kind> kindNumberer

typeNumberer

protected ArrayNumberer<Type> typeNumberer

methodNumberer

protected ArrayNumberer<SootMethod> methodNumberer

unitNumberer
```
protected Numberer<Unit> unitNumberer
```

contextNumberer

protected Numberer<Context> contextNumberer

fieldNumberer

protected Numberer<SparkField> fieldNumberer

classNumberer

protected ArrayNumberer<SootClass> classNumberer

subSigNumberer

protected StringNumberer subSigNumberer

localNumberer

protected ArrayNumberer<Local> localNumberer

activeHierarchy
```
protected Hierarchy activeHierarchy
```

activeFastHierarchy

protected FastHierarchy activeFastHierarchy

activeCallGraph
```
protected CallGraph activeCallGraph
```

reachableMethods

protected ReachableMethods reachableMethods

activePointsToAnalysis

protected PointsToAnalysis activePointsToAnalysis

activeSideEffectAnalysis

protected SideEffectAnalysis activeSideEffectAnalysis

entryPoints
```
protected List<SootMethod> entryPoints
```

accessibilityOracle

protected ClientAccessibilityOracle accessibilityOracle

allowsPhantomRefs
```
protected boolean allowsPhantomRefs
```

mainClass
```
protected SootClass mainClass
```

sootClassPath
```
protected String sootClassPath
```

excludedPackages

protected LinkedList<String> excludedPackages

Constructor Detail
- Scene
```
public Scene(Singletons.Global g)
```

Method Detail
- v
```
public static Scene v()
```
- setMainClass
```
public void setMainClass(SootClass m)
```
- getReservedNames
```
public Set<String> getReservedNames()
```
  Returns a set of tokens which are reserved. Any field, class, method, or local variable with such a name will be quoted.
- quotedNameOf
```
public String quotedNameOf(String s)
```
  If this name is in the set of reserved names, then return a quoted version of it. Else pass it through. If the name consists of multiple parts separated by dots, the individual names are checked as well.
- unescapeName
```
public String unescapeName(String s)
```
  This method is the inverse of quotedNameOf(). It takes a possible escaped class and reconstructs the original version of it.
  
  Parameters:
  
  s - The possibly escaped name
  
  Returns:
  
  The original, non-escaped name
- hasMainClass
```
public boolean hasMainClass()
```
- getMainClass
```
public SootClass getMainClass()
```
- getMainMethod
```
public SootMethod getMainMethod()
```
- setSootClassPath
```
public void setSootClassPath(String p)
```
- extendSootClassPath
```
public void extendSootClassPath(String newPathElement)
```
- getSootClassPath
```
public String getSootClassPath()
```
- getAndroidJarPath
```
public String getAndroidJarPath(String jars,
                                String apk)
```
- getAndroidAPIVersion
```
public int getAndroidAPIVersion()
```
- defaultClassPath
```
public String defaultClassPath()
```
- isApk
```
public static boolean isApk(String file)
```
- getState
```
public int getState()
```
- modifyHierarchy
```
protected void modifyHierarchy()
```
- addClass
```
public void addClass(SootClass c)
```
  Adds the given class to the Scene. This method marks the given class as a library class and invalidates the class hierarchy.
  
  Parameters:
  
  c - The class to add
- addClassSilent
```
protected void addClassSilent(SootClass c)
```
  Adds the given class to the Scene. This method does not handle any dependencies such as invalidating the hierarchy. The class is neither marked as application class, nor library class.
  
  Parameters:
  
  c - The class to add
- removeClass
```
public void removeClass(SootClass c)
```
- containsClass
```
public boolean containsClass(String className)
```
- containsType
```
public boolean containsType(String className)
```
- signatureToClass
```
public String signatureToClass(String sig)
```
- signatureToSubsignature
```
public String signatureToSubsignature(String sig)
```
- grabField
```
public SootField grabField(String fieldSignature)
```
- containsField
```
public boolean containsField(String fieldSignature)
```
- grabMethod
```
public SootMethod grabMethod(String methodSignature)
```
- containsMethod
```
public boolean containsMethod(String methodSignature)
```
- getField
```
public SootField getField(String fieldSignature)
```
- getMethod
```
public SootMethod getMethod(String methodSignature)
```
- tryLoadClass
```
public SootClass tryLoadClass(String className,
                              int desiredLevel)
```
  Attempts to load the given class and all of the required support classes. Returns the original class if it was loaded, or null otherwise.
- loadClassAndSupport
```
public SootClass loadClassAndSupport(String className)
```
  Loads the given class and all of the required support classes. Returns the first class.
- loadClass
```
public SootClass loadClass(String className,
                           int desiredLevel)
```
- getType
```
public Type getType(String arg)
```
  Returns the RefType with the given class name or primitive type.
  
  Throws:
  
  RuntimeException - if the Type for this name cannot be found. Use getRefTypeUnsafe(String) to check if type is an registered RefType.
- getTypeUnsafe
```
public Type getTypeUnsafe(String arg)
```
  Returns a Type object representing the given type string. It will first attempt to resolve the type as a reference type that currently exists in the Scene. If this fails it will attempt to resolve the type as a java primitive type. Lastly, if phantom refs are allowed it will construct a phantom class for the given type and return a reference type based on the phantom class. Otherwise, this method will return null. Note, if the resolved base type is not null and the string representation of the type is an array, the returned type will be an ArrayType with the base type resolved as described above.
  
  Parameters:
  
  arg - A string description of the type
  
  Returns:
  
  The Type if it can be resolved and null otherwise
- getTypeUnsafe
```
public Type getTypeUnsafe(String arg,
                          boolean phantomNonExist)
```
  Returns a Type object representing the given type string. It will first attempt to resolve the type as a reference type that currently exists in the Scene. If this fails it will attempt to resolve the type as a java primitive type. Lastly, if phantom refs are allowed and phantomNonExist=true it will construct a phantom class for the given type and return a reference type based on the phantom class. Otherwise, this method will return null. Note, if the resolved base type is not null and the string representation of the type is an array, the returned type will be an ArrayType with the base type resolved as described above.
  
  Parameters:
  
  arg - A string description of the type
  
  phantomNonExist - Indicates that a phantom class should be created for the given type string and a Type object should be created based on the phantom class if a class matching the type name does not exists in the scene and phantom refs are allowed
  
  Returns:
  
  The Type if it can be resolved and null otherwise
- getRefType
```
public RefType getRefType(String className)
```
  Returns the RefType with the given className.
  
  Throws:
  
  IllegalStateException - if the RefType for this class cannot be found. Use containsType(String) to check if type is registered
- getRefTypeUnsafe
```
public RefType getRefTypeUnsafe(String className)
```
  Returns the RefType with the given className. Returns null if no type with the given name can be found.
- getObjectType
```
public RefType getObjectType()
```
  Returns the RefType for Object.
- addRefType
```
public void addRefType(RefType type)
```
  Returns the RefType with the given className.
- getSootClassUnsafe
```
public SootClass getSootClassUnsafe(String className)
```
  Returns the SootClass with the given className. If no class with the given name exists, null is returned unless phantom refs are allowed. In this case, a new phantom class is created.
  
  Parameters:
  
  className - The name of the class to get
  
  Returns:
  
  The class if it exists, otherwise null
- getSootClassUnsafe
```
public SootClass getSootClassUnsafe(String className,
                                    boolean phantomNonExist)
```
  Returns the SootClass with the given className. If no class with the given name exists, null is returned unless phantomNonExist=true and phantom refs are allowed. In this case, a new phantom class is created and returned.
  
  Parameters:
  
  className - The name of the class to get
  
  phantomNonExist - Indicates that a phantom class should be created if a class with the given name does not exist and phantom refs are allowed
  
  Returns:
  
  The class if it exists, otherwise null
- getSootClass
```
public SootClass getSootClass(String className)
```
  Returns the SootClass with the given className.
- getClasses
```
public Chain<SootClass> getClasses()
```
  Returns an backed chain of the classes in this manager.
- getApplicationClasses
```
public Chain<SootClass> getApplicationClasses()
```
  Returns a chain of the application classes in this scene. These classes are the ones which can be freely analysed & modified.
- getLibraryClasses
```
public Chain<SootClass> getLibraryClasses()
```
  Returns a chain of the library classes in this scene. These classes can be analysed but not modified.
- getPhantomClasses
```
public Chain<SootClass> getPhantomClasses()
```
  Returns a chain of the phantom classes in this scene. These classes are referred to by other classes, but cannot be loaded.
- getSideEffectAnalysis
```
public SideEffectAnalysis getSideEffectAnalysis()
```
  Retrieves the active side-effect analysis
- setSideEffectAnalysis
```
public void setSideEffectAnalysis(SideEffectAnalysis sea)
```
  Sets the active side-effect analysis
- hasSideEffectAnalysis
```
public boolean hasSideEffectAnalysis()
```
- releaseSideEffectAnalysis
```
public void releaseSideEffectAnalysis()
```
- getPointsToAnalysis
```
public PointsToAnalysis getPointsToAnalysis()
```
  Retrieves the active pointer analysis
- setPointsToAnalysis
```
public void setPointsToAnalysis(PointsToAnalysis pa)
```
  Sets the active pointer analysis
- hasPointsToAnalysis
```
public boolean hasPointsToAnalysis()
```
- releasePointsToAnalysis
```
public void releasePointsToAnalysis()
```
- getClientAccessibilityOracle
```
public ClientAccessibilityOracle getClientAccessibilityOracle()
```
  Retrieves the active client accessibility oracle
- hasClientAccessibilityOracle
```
public boolean hasClientAccessibilityOracle()
```
- setClientAccessibilityOracle
```
public void setClientAccessibilityOracle(ClientAccessibilityOracle oracle)
```
- releaseClientAccessibilityOracle
```
public void releaseClientAccessibilityOracle()
```
- getOrMakeFastHierarchy
```
public FastHierarchy getOrMakeFastHierarchy()
```
  Makes a new fast hierarchy is none is active, and returns the active fast hierarchy.
- getFastHierarchy
```
public FastHierarchy getFastHierarchy()
```
  Retrieves the active fast hierarchy
- setFastHierarchy
```
public void setFastHierarchy(FastHierarchy hierarchy)
```
  Sets the active hierarchy
- hasFastHierarchy
```
public boolean hasFastHierarchy()
```
- releaseFastHierarchy
```
public void releaseFastHierarchy()
```
- getActiveHierarchy
```
public Hierarchy getActiveHierarchy()
```
  Retrieves the active hierarchy
- setActiveHierarchy
```
public void setActiveHierarchy(Hierarchy hierarchy)
```
  Sets the active hierarchy
- hasActiveHierarchy
```
public boolean hasActiveHierarchy()
```
- releaseActiveHierarchy
```
public void releaseActiveHierarchy()
```
- hasCustomEntryPoints
```
public boolean hasCustomEntryPoints()
```
- getEntryPoints
```
public List<SootMethod> getEntryPoints()
```
  Get the set of entry points that are used to build the call graph.
- setEntryPoints
```
public void setEntryPoints(List<SootMethod> entryPoints)
```
  Change the set of entry point methods used to build the call graph.
- getContextSensitiveCallGraph
```
public ContextSensitiveCallGraph getContextSensitiveCallGraph()
```
- setContextSensitiveCallGraph
```
public void setContextSensitiveCallGraph(ContextSensitiveCallGraph cscg)
```
- getCallGraph
```
public CallGraph getCallGraph()
```
- setCallGraph
```
public void setCallGraph(CallGraph cg)
```
- hasCallGraph
```
public boolean hasCallGraph()
```
- releaseCallGraph
```
public void releaseCallGraph()
```
- getReachableMethods
```
public ReachableMethods getReachableMethods()
```
- setReachableMethods
```
public void setReachableMethods(ReachableMethods rm)
```
- hasReachableMethods
```
public boolean hasReachableMethods()
```
- releaseReachableMethods
```
public void releaseReachableMethods()
```
- getPhantomRefs
```
public boolean getPhantomRefs()
```
- setPhantomRefs
```
public void setPhantomRefs(boolean value)
```
- allowsPhantomRefs
```
public boolean allowsPhantomRefs()
```
- kindNumberer
```
public Numberer<Kind> kindNumberer()
```
- getTypeNumberer
```
public ArrayNumberer<Type> getTypeNumberer()
```
- getMethodNumberer
```
public ArrayNumberer<SootMethod> getMethodNumberer()
```
- getContextNumberer
```
public Numberer<Context> getContextNumberer()
```
- getUnitNumberer
```
public Numberer<Unit> getUnitNumberer()
```
- getFieldNumberer
```
public Numberer<SparkField> getFieldNumberer()
```
- getClassNumberer
```
public ArrayNumberer<SootClass> getClassNumberer()
```
- getSubSigNumberer
```
public StringNumberer getSubSigNumberer()
```
- getLocalNumberer
```
public ArrayNumberer<Local> getLocalNumberer()
```
- setContextNumberer
```
public void setContextNumberer(Numberer<Context> n)
```
- getDefaultThrowAnalysis
```
public ThrowAnalysis getDefaultThrowAnalysis()
```
  Returns the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.
  
  Returns:
  
  the default ThrowAnalysis
- setDefaultThrowAnalysis
```
public void setDefaultThrowAnalysis(ThrowAnalysis ta)
```
  Sets the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.
  
  Parameters:
  
  ta - the default ThrowAnalysis.
- addBasicClass
```
public void addBasicClass(String name)
```
- addBasicClass
```
public void addBasicClass(String name,
                          int level)
```
- loadBasicClasses
```
public void loadBasicClasses()
```
  Load just the set of basic classes soot needs, ignoring those specified on the command-line. You don't need to use both this and loadNecessaryClasses, though it will only waste time.
- getBasicClasses
```
public Set<String> getBasicClasses()
```
- dynamicClasses
```
public Collection<SootClass> dynamicClasses()
```
- loadNecessaryClasses
```
public void loadNecessaryClasses()
```
  Load the set of classes that soot needs, including those specified on the command-line. This is the standard way of initialising the list of classes soot should use.
- loadDynamicClasses
```
public void loadDynamicClasses()
```
- isExcluded
```
public boolean isExcluded(SootClass sc)
```
- isIncluded
```
public boolean isIncluded(SootClass sc)
```
- setPkgList
```
public void setPkgList(List<String> list)
```
- getPkgList
```
public List<String> getPkgList()
```
- makeMethodRef
```
public SootMethodRef makeMethodRef(SootClass declaringClass,
                                   String name,
                                   List<Type> parameterTypes,
                                   Type returnType,
                                   boolean isStatic)
```
  Create an unresolved reference to a method.
- makeConstructorRef
```
public SootMethodRef makeConstructorRef(SootClass declaringClass,
                                        List<Type> parameterTypes)
```
  Create an unresolved reference to a constructor.
- makeFieldRef
```
public SootFieldRef makeFieldRef(SootClass declaringClass,
                                 String name,
                                 Type type,
                                 boolean isStatic)
```
  Create an unresolved reference to a field.
- getClasses
```
public List<SootClass> getClasses(int desiredLevel)
```
  Returns the list of SootClasses that have been resolved at least to the level specified.
- doneResolving
```
public boolean doneResolving()
```
- setDoneResolving
```
public void setDoneResolving()
```
- setMainClassFromOptions
```
public void setMainClassFromOptions()
```
- isIncrementalBuild
```
public boolean isIncrementalBuild()
```
  This method returns true when in incremental build mode. Other classes can query this flag and change the way in which they use the Scene, depending on the flag's value.
- initiateIncrementalBuild
```
public void initiateIncrementalBuild()
```
- incrementalBuildFinished
```
public void incrementalBuildFinished()
```
- forceResolve
```
public SootClass forceResolve(String className,
                              int level)
```
- makeSootClass
```
public SootClass makeSootClass(String name)
```
- makeSootClass
```
public SootClass makeSootClass(String name,
                               int modifiers)
```
- makeSootMethod
```
public SootMethod makeSootMethod(String name,
                                 List<Type> parameterTypes,
                                 Type returnType)
```
- makeSootMethod
```
public SootMethod makeSootMethod(String name,
                                 List<Type> parameterTypes,
                                 Type returnType,
                                 int modifiers)
```
- makeSootMethod
```
public SootMethod makeSootMethod(String name,
                                 List<Type> parameterTypes,
                                 Type returnType,
                                 int modifiers,
                                 List<SootClass> thrownExceptions)
```
- makeSootField
```
public SootField makeSootField(String name,
                               Type type,
                               int modifiers)
```
- makeSootField
```
public SootField makeSootField(String name,
                               Type type)
```
- getOrAddRefType
```
public RefType getOrAddRefType(RefType tp)
```
- internalMakeCallGraph
```
public CallGraph internalMakeCallGraph()
```
  SOOT USERS: DO NOT CALL THIS METHOD!
  
  This method is a Soot-internal factory method for generating callgraph objects. It creates non-initialized object that must then be initialized by a callgraph algorithm
  
  Returns:
  
  A new callgraph empty object

Class Scene

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kindNumberer

typeNumberer

methodNumberer

unitNumberer

contextNumberer

fieldNumberer

classNumberer

subSigNumberer

localNumberer

activeHierarchy

activeFastHierarchy

activeCallGraph

reachableMethods

activePointsToAnalysis

activeSideEffectAnalysis

entryPoints

accessibilityOracle

allowsPhantomRefs

mainClass

sootClassPath

excludedPackages

Constructor Detail

Scene

Method Detail

v

setMainClass

getReservedNames

quotedNameOf

unescapeName

hasMainClass

getMainClass

getMainMethod

setSootClassPath

extendSootClassPath

getSootClassPath

getAndroidJarPath

getAndroidAPIVersion

defaultClassPath

isApk

getState

modifyHierarchy

addClass

addClassSilent

removeClass

containsClass

containsType

signatureToClass

signatureToSubsignature

grabField

containsField

grabMethod

containsMethod

getField

getMethod

tryLoadClass

loadClassAndSupport

loadClass

getType

getTypeUnsafe

getTypeUnsafe

getRefType

getRefTypeUnsafe

getObjectType

addRefType

getSootClassUnsafe

getSootClassUnsafe

getSootClass

getClasses

getApplicationClasses

getLibraryClasses

getPhantomClasses

getSideEffectAnalysis

setSideEffectAnalysis

hasSideEffectAnalysis