SootClass (Soot API)

java.lang.Object
- soot.tagkit.AbstractHost
- - soot.SootClass

All Implemented Interfaces:

Host, Numberable
```
public class SootClass
extends AbstractHost
implements Numberable
```
Soot representation of a Java class. They are usually created by a Scene, but can also be constructed manually through the given constructors.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BODIES`
`static int`	`DANGLING`
`protected Chain<SootField>`	`fields`
`protected java.lang.String`	`fixedPackageName`
`protected java.lang.String`	`fixedShortName`
`static int`	`HIERARCHY`
`protected Chain<SootClass>`	`interfaces`
`static java.lang.String`	`INVOKEDYNAMIC_DUMMY_CLASS_NAME`
`protected boolean`	`isInScene`
`protected boolean`	`isPhantom`
`protected java.util.List<SootMethod>`	`methodList`
`protected int`	`modifiers`
`protected java.lang.String`	`name`
`protected SootClass`	`outerClass`
`protected java.lang.String`	`packageName`
`protected java.lang.String`	`shortName`
`static int`	`SIGNATURES`
`protected SmallNumberedMap<SootMethod>`	`subSigToMethods`
`protected SootClass`	`superClass`

Fields inherited from class soot.tagkit.AbstractHost
col, line

Constructor Summary

Constructors
Constructor and Description
`SootClass(java.lang.String name)` Constructs an empty SootClass with the given name and no modifiers.
`SootClass(java.lang.String name, int modifiers)` Constructs an empty SootClass with the given name and modifiers.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addField(SootField f)` Adds the given field to this class.
`void`	`addInterface(SootClass interfaceClass)` Add the given class to the list of interfaces which are directly implemented by this class.
`void`	`addMethod(SootMethod m)` Adds the given method to this class.
`void`	`checkLevel(int level)` Checks if the class has at lease the resolving level specified.
`void`	`checkLevelIgnoreResolving(int level)` Checks if the class has at lease the resolving level specified.
`boolean`	`containsBafBody()` Returns true if some method in this class has an active Baf body.
`boolean`	`declaresField(java.lang.String subsignature)` Does this class declare a field with the given subsignature?
`boolean`	`declaresField(java.lang.String name, Type type)` Does this class declare a field with the given name and type.
`boolean`	`declaresFieldByName(java.lang.String name)` Does this class declare a field with the given name?
`boolean`	`declaresMethod(NumberedString subsignature)` Does this class declare a method with the given subsignature?
`boolean`	`declaresMethod(java.lang.String subsignature)` Does this class declare a method with the given subsignature?
`boolean`	`declaresMethod(java.lang.String name, java.util.List<Type> parameterTypes)` Does this class declare a method with the given name and parameter types?
`boolean`	`declaresMethod(java.lang.String name, java.util.List<Type> parameterTypes, Type returnType)` Does this class declare a method with the given name, parameter types, and return type?
`boolean`	`declaresMethodByName(java.lang.String name)` Does this class declare a method with the given name?
`SootField`	`getField(java.lang.String subsignature)` Returns the field of this class with the given subsignature.
`SootField`	`getField(java.lang.String name, Type type)` Returns the field of this class with the given name and type.
`SootField`	`getFieldByName(java.lang.String name)` Returns the field of this class with the given name.
`SootField`	`getFieldByNameUnsafe(java.lang.String name)` Returns the field of this class with the given name.
`int`	`getFieldCount()` Returns the number of fields in this class.
`Chain<SootField>`	`getFields()` Returns a backed Chain of fields.
`SootField`	`getFieldUnsafe(java.lang.String subsignature)` Returns the field of this class with the given subsignature.
`SootField`	`getFieldUnsafe(java.lang.String name, Type type)` Returns the field of this class with the given name and type.
`int`	`getInterfaceCount()` Returns the number of interfaces being directly implemented by this class.
`Chain<SootClass>`	`getInterfaces()` Returns a backed Chain of the interfaces that are directly implemented by this class.
`java.lang.String`	`getJavaPackageName()`
`java.lang.String`	`getJavaStyleName()`
`SootMethod`	`getMethod(NumberedString subsignature)` Returns the method of this class with the given subsignature.
`SootMethod`	`getMethod(java.lang.String subsignature)`
`SootMethod`	`getMethod(java.lang.String name, java.util.List<Type> parameterTypes)` Attempts to retrieve the method with the given name and parameters.
`SootMethod`	`getMethod(java.lang.String name, java.util.List<Type> parameterTypes, Type returnType)` Attempts to retrieve the method with the given name, parameters and return type.
`SootMethod`	`getMethodByName(java.lang.String name)` Attempts to retrieve the method with the given name.
`SootMethod`	`getMethodByNameUnsafe(java.lang.String name)` Attempts to retrieve the method with the given name.
`int`	`getMethodCount()` Returns the number of methods in this class.
`java.util.List<SootMethod>`	`getMethods()`
`SootMethod`	`getMethodUnsafe(NumberedString subsignature)` Returns the method of this class with the given subsignature.
`SootMethod`	`getMethodUnsafe(java.lang.String subsignature)`
`SootMethod`	`getMethodUnsafe(java.lang.String name, java.util.List<Type> parameterTypes, Type returnType)` Attempts to retrieve the method with the given name, parameters and return type.
`int`	`getModifiers()` Returns the modifiers of this class.
`java.lang.String`	`getName()` Returns the name of this class.
`int`	`getNumber()`
`SootClass`	`getOuterClass()`
`java.lang.String`	`getPackageName()` Returns the package name of this class.
`java.lang.String`	`getShortJavaStyleName()`
`java.lang.String`	`getShortName()`
`SootClass`	`getSuperclass()` WARNING: interfaces are subclasses of the java.lang.Object class! Returns the superclass of this class.
`RefType`	`getType()` Returns the RefType corresponding to this class.
`boolean`	`hasOuterClass()`
`boolean`	`hasRefType()`
`boolean`	`hasSuperclass()` WARNING: interfaces are subclasses of the java.lang.Object class! Does this class have a superclass? False implies that this is the java.lang.Object class.
`boolean`	`implementsInterface(java.lang.String name)` Does this class directly implement the given interface? (see getInterfaceCount())
`boolean`	`isAbstract()` Convenience method returning true if this class is abstract.
`boolean`	`isApplicationClass()` Convenience method returning true if this class is an application class.
`boolean`	`isConcrete()` Returns true if this class is not an interface and not abstract.
`boolean`	`isFinal()` Convenience method returning true if this class is final.
`boolean`	`isInnerClass()`
`boolean`	`isInScene()`
`boolean`	`isInterface()` Convenience method; returns true if this class is an interface.
`boolean`	`isJavaLibraryClass()` Sometimes we need to know which class is a JDK class.
`boolean`	`isLibraryClass()` Convenience method returning true if this class is a library class.
`boolean`	`isPhantom()` Convenience method returning true if this class is phantom.
`boolean`	`isPhantomClass()` Convenience method returning true if this class is a phantom class.
`boolean`	`isPrivate()` Convenience method returning true if this class is private.
`boolean`	`isProtected()` Convenience method returning true if this class is protected.
`boolean`	`isPublic()` Convenience method; returns true if this class is public.
`boolean`	`isStatic()` Convenience method returning true if this class is static.
`java.util.Iterator<SootMethod>`	`methodIterator()` Returns an iterator over the methods in this class.
`void`	`removeField(SootField f)` Removes the given field from this class.
`void`	`removeInterface(SootClass interfaceClass)` Removes the given class from the list of interfaces which are directly implemented by this class.
`void`	`removeMethod(SootMethod m)` Removes the given method from this class.
`void`	`rename(java.lang.String newName)`
`void`	`renameFieldsAndMethods(boolean privateOnly)`
`int`	`resolvingLevel()`
`void`	`setApplicationClass()` Makes this class an application class.
`void`	`setInScene(boolean isInScene)` Tells this class if it is being managed by a Scene.
`void`	`setLibraryClass()` Makes this class a library class.
`void`	`setModifiers(int modifiers)` Sets the modifiers for this class.
`void`	`setName(java.lang.String name)` Sets the name of this class.
`void`	`setNumber(int number)`
`void`	`setOuterClass(SootClass c)`
`void`	`setPhantom(boolean value)` Marks this class as phantom, without notifying the Scene.
`void`	`setPhantomClass()` Makes this class a phantom class.
`void`	`setRefType(RefType refType)`
`void`	`setResolvingLevel(int newLevel)`
`void`	`setSuperclass(SootClass c)` Sets the superclass of this class.
`java.lang.String`	`toString()` Returns the name of this class.
`void`	`validate()` Validates this SootClass for logical errors.
`void`	`validate(java.util.List<ValidationException> exceptionList)` Validates this SootClass for logical errors.

Methods inherited from class soot.tagkit.AbstractHost
addAllTagsOf, addTag, getJavaSourceStartColumnNumber, getJavaSourceStartLineNumber, getTag, getTags, hasTag, removeAllTags, removeTag

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

- Field Detail
  - name
```
protected java.lang.String name
```
  - shortName
```
protected java.lang.String shortName
```
  - fixedShortName
```
protected java.lang.String fixedShortName
```
  - packageName
```
protected java.lang.String packageName
```
  - fixedPackageName
```
protected java.lang.String fixedPackageName
```
  - modifiers
```
protected int modifiers
```
  - fields
```
protected Chain<SootField> fields
```
  - subSigToMethods
```
protected SmallNumberedMap<SootMethod> subSigToMethods
```
  - methodList
```
protected java.util.List<SootMethod> methodList
```
  - interfaces
```
protected Chain<SootClass> interfaces
```
  - isInScene
```
protected boolean isInScene
```
  - superClass
```
protected SootClass superClass
```
  - outerClass
```
protected SootClass outerClass
```
  - isPhantom
```
protected boolean isPhantom
```
  - INVOKEDYNAMIC_DUMMY_CLASS_NAME
```
public static final java.lang.String INVOKEDYNAMIC_DUMMY_CLASS_NAME
```
    See Also:
    Constant Field Values
  - DANGLING
```
public static final int DANGLING
```
    See Also:
    Constant Field Values
  - HIERARCHY
```
public static final int HIERARCHY
```
    See Also:
    Constant Field Values
  - SIGNATURES
```
public static final int SIGNATURES
```
    See Also:
    Constant Field Values
  - BODIES
```
public static final int BODIES
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SootClass
```
public SootClass(java.lang.String name,
         int modifiers)
```
    Constructs an empty SootClass with the given name and modifiers.
  - SootClass
```
public SootClass(java.lang.String name)
```
    Constructs an empty SootClass with the given name and no modifiers.
- Method Detail
  - checkLevel
```
public void checkLevel(int level)
```
    Checks if the class has at lease the resolving level specified. This check does nothing is the class resolution process is not completed.
    
    Parameters:
    level - the resolution level, one of DANGLING, HIERARCHY, SIGNATURES, and BODIES
    
    Throws:
    
    java.lang.RuntimeException - if the resolution is at an insufficient level
  - checkLevelIgnoreResolving
```
public void checkLevelIgnoreResolving(int level)
```
    Checks if the class has at lease the resolving level specified. This check ignores the resolution completeness.
    
    Parameters:
    level - the resolution level, one of DANGLING, HIERARCHY, SIGNATURES, and BODIES
    
    Throws:
    
    java.lang.RuntimeException - if the resolution is at an insufficient level
  - resolvingLevel
```
public int resolvingLevel()
```
  - setResolvingLevel
```
public void setResolvingLevel(int newLevel)
```
  - isInScene
```
public boolean isInScene()
```
  - setInScene
```
public void setInScene(boolean isInScene)
```
    Tells this class if it is being managed by a Scene.
  - getFieldCount
```
public int getFieldCount()
```
    Returns the number of fields in this class.
  - getFields
```
public Chain<SootField> getFields()
```
    Returns a backed Chain of fields.
  - addField
```
public void addField(SootField f)
```
    Adds the given field to this class.
  - removeField
```
public void removeField(SootField f)
```
    Removes the given field from this class.
  - getField
```
public SootField getField(java.lang.String name,
                 Type type)
```
    Returns the field of this class with the given name and type. If the field cannot be found, an exception is thrown.
  - getFieldUnsafe
```
public SootField getFieldUnsafe(java.lang.String name,
                       Type type)
```
    Returns the field of this class with the given name and type. If the field cannot be found, null is returned.
  - getFieldByName
```
public SootField getFieldByName(java.lang.String name)
```
    Returns the field of this class with the given name. Throws a RuntimeException if there is more than one field with the given name or if no such field exists at all.
  - getFieldByNameUnsafe
```
public SootField getFieldByNameUnsafe(java.lang.String name)
```
    Returns the field of this class with the given name. Throws a RuntimeException if there is more than one field with the given name. Returns null if no field with the given name exists.
  - getField
```
public SootField getField(java.lang.String subsignature)
```
    Returns the field of this class with the given subsignature. If such a field does not exist, an exception is thrown.
  - getFieldUnsafe
```
public SootField getFieldUnsafe(java.lang.String subsignature)
```
    Returns the field of this class with the given subsignature. If such a field does not exist, null is returned.
  - declaresField
```
public boolean declaresField(java.lang.String subsignature)
```
    Does this class declare a field with the given subsignature?
  - getMethod
```
public SootMethod getMethod(NumberedString subsignature)
```
    Returns the method of this class with the given subsignature. If no method with the given subsignature can be found, an exception is thrown.
  - getMethodUnsafe
```
public SootMethod getMethodUnsafe(NumberedString subsignature)
```
    Returns the method of this class with the given subsignature. If no method with the given subsignature can be found, null is returned.
  - declaresMethod
```
public boolean declaresMethod(NumberedString subsignature)
```
    Does this class declare a method with the given subsignature?
  - getMethod
```
public SootMethod getMethod(java.lang.String subsignature)
```
  - getMethodUnsafe
```
public SootMethod getMethodUnsafe(java.lang.String subsignature)
```
  - declaresMethod
```
public boolean declaresMethod(java.lang.String subsignature)
```
    Does this class declare a method with the given subsignature?
  - declaresFieldByName
```
public boolean declaresFieldByName(java.lang.String name)
```
    Does this class declare a field with the given name?
  - declaresField
```
public boolean declaresField(java.lang.String name,
                    Type type)
```
    Does this class declare a field with the given name and type.
  - getMethodCount
```
public int getMethodCount()
```
    Returns the number of methods in this class.
  - methodIterator
```
public java.util.Iterator<SootMethod> methodIterator()
```
    Returns an iterator over the methods in this class.
  - getMethods
```
public java.util.List<SootMethod> getMethods()
```
  - getMethod
```
public SootMethod getMethod(java.lang.String name,
                   java.util.List<Type> parameterTypes,
                   Type returnType)
```
    Attempts to retrieve the method with the given name, parameters and return type. If no matching method can be found, an exception is thrown.
  - getMethodUnsafe
```
public SootMethod getMethodUnsafe(java.lang.String name,
                         java.util.List<Type> parameterTypes,
                         Type returnType)
```
    Attempts to retrieve the method with the given name, parameters and return type. If no matching method can be found, null is returned.
  - getMethod
```
public SootMethod getMethod(java.lang.String name,
                   java.util.List<Type> parameterTypes)
```
    Attempts to retrieve the method with the given name and parameters. This method may throw an AmbiguousMethodException if there is more than one method with the given name and parameter.
  - getMethodByNameUnsafe
```
public SootMethod getMethodByNameUnsafe(java.lang.String name)
```
    Attempts to retrieve the method with the given name. This method may throw an AmbiguousMethodException if there are more than one method with the given name. If no method with the given is found, null is returned.
  - getMethodByName
```
public SootMethod getMethodByName(java.lang.String name)
```
    Attempts to retrieve the method with the given name. This method may throw an AmbiguousMethodException if there are more than one method with the given name. If no method with the given is found, an exception is thrown as well.
  - declaresMethod
```
public boolean declaresMethod(java.lang.String name,
                     java.util.List<Type> parameterTypes)
```
    Does this class declare a method with the given name and parameter types?
  - declaresMethod
```
public boolean declaresMethod(java.lang.String name,
                     java.util.List<Type> parameterTypes,
                     Type returnType)
```
    Does this class declare a method with the given name, parameter types, and return type?
  - declaresMethodByName
```
public boolean declaresMethodByName(java.lang.String name)
```
    Does this class declare a method with the given name?
  - addMethod
```
public void addMethod(SootMethod m)
```
    Adds the given method to this class.
  - removeMethod
```
public void removeMethod(SootMethod m)
```
    Removes the given method from this class.
  - getModifiers
```
public int getModifiers()
```
    Returns the modifiers of this class.
  - setModifiers
```
public void setModifiers(int modifiers)
```
    Sets the modifiers for this class.
  - getInterfaceCount
```
public int getInterfaceCount()
```
    Returns the number of interfaces being directly implemented by this class. Note that direct implementation corresponds to an "implements" keyword in the Java class file and that this class may still be implementing additional interfaces in the usual sense by being a subclass of a class which directly implements some interfaces.
  - getInterfaces
```
public Chain<SootClass> getInterfaces()
```
    Returns a backed Chain of the interfaces that are directly implemented by this class. (see getInterfaceCount())
  - implementsInterface
```
public boolean implementsInterface(java.lang.String name)
```
    Does this class directly implement the given interface? (see getInterfaceCount())
  - addInterface
```
public void addInterface(SootClass interfaceClass)
```
    Add the given class to the list of interfaces which are directly implemented by this class.
  - removeInterface
```
public void removeInterface(SootClass interfaceClass)
```
    Removes the given class from the list of interfaces which are directly implemented by this class.
  - hasSuperclass
```
public boolean hasSuperclass()
```
    WARNING: interfaces are subclasses of the java.lang.Object class! Does this class have a superclass? False implies that this is the java.lang.Object class. Note that interfaces are subclasses of the java.lang.Object class.
  - getSuperclass
```
public SootClass getSuperclass()
```
    WARNING: interfaces are subclasses of the java.lang.Object class! Returns the superclass of this class. (see hasSuperclass())
  - setSuperclass
```
public void setSuperclass(SootClass c)
```
    Sets the superclass of this class. Note that passing a null will cause the class to have no superclass.
  - hasOuterClass
```
public boolean hasOuterClass()
```
  - getOuterClass
```
public SootClass getOuterClass()
```
  - setOuterClass
```
public void setOuterClass(SootClass c)
```
  - isInnerClass
```
public boolean isInnerClass()
```
  - getName
```
public java.lang.String getName()
```
    Returns the name of this class.
  - getJavaStyleName
```
public java.lang.String getJavaStyleName()
```
  - getShortJavaStyleName
```
public java.lang.String getShortJavaStyleName()
```
  - getShortName
```
public java.lang.String getShortName()
```
  - getPackageName
```
public java.lang.String getPackageName()
```
    Returns the package name of this class.
  - getJavaPackageName
```
public java.lang.String getJavaPackageName()
```
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this class.
  - isInterface
```
public boolean isInterface()
```
    Convenience method; returns true if this class is an interface.
  - isConcrete
```
public boolean isConcrete()
```
    Returns true if this class is not an interface and not abstract.
  - isPublic
```
public boolean isPublic()
```
    Convenience method; returns true if this class is public.
  - containsBafBody
```
public boolean containsBafBody()
```
    Returns true if some method in this class has an active Baf body.
  - setRefType
```
public void setRefType(RefType refType)
```
  - hasRefType
```
public boolean hasRefType()
```
  - getType
```
public RefType getType()
```
    Returns the RefType corresponding to this class.
  - toString
```
public java.lang.String toString()
```
    Returns the name of this class.
    
    Overrides:
    
    toString in class java.lang.Object
  - renameFieldsAndMethods
```
public void renameFieldsAndMethods(boolean privateOnly)
```
  - isApplicationClass
```
public boolean isApplicationClass()
```
    Convenience method returning true if this class is an application class.
    
    See Also:
    Scene.getApplicationClasses()
  - setApplicationClass
```
public void setApplicationClass()
```
    Makes this class an application class.
  - isLibraryClass
```
public boolean isLibraryClass()
```
    Convenience method returning true if this class is a library class.
    
    See Also:
    Scene.getLibraryClasses()
  - setLibraryClass
```
public void setLibraryClass()
```
    Makes this class a library class.
  - isJavaLibraryClass
```
public boolean isJavaLibraryClass()
```
    Sometimes we need to know which class is a JDK class. There is no simple way to distinguish a user class and a JDK class, here we use the package prefix as the heuristic.
  - isPhantomClass
```
public boolean isPhantomClass()
```
    Convenience method returning true if this class is a phantom class.
    
    See Also:
    Scene.getPhantomClasses()
  - setPhantomClass
```
public void setPhantomClass()
```
    Makes this class a phantom class.
  - isPhantom
```
public boolean isPhantom()
```
    Convenience method returning true if this class is phantom.
  - setPhantom
```
public void setPhantom(boolean value)
```
    Marks this class as phantom, without notifying the Scene.
  - isPrivate
```
public boolean isPrivate()
```
    Convenience method returning true if this class is private.
  - isProtected
```
public boolean isProtected()
```
    Convenience method returning true if this class is protected.
  - isAbstract
```
public boolean isAbstract()
```
    Convenience method returning true if this class is abstract.
  - isFinal
```
public boolean isFinal()
```
    Convenience method returning true if this class is final.
  - isStatic
```
public boolean isStatic()
```
    Convenience method returning true if this class is static.
  - getNumber
```
public final int getNumber()
```
    Specified by:
    
    getNumber in interface Numberable
  - setNumber
```
public final void setNumber(int number)
```
    Specified by:
    
    setNumber in interface Numberable
  - rename
```
public void rename(java.lang.String newName)
```
  - validate
```
public void validate()
```
    Validates this SootClass for logical errors. Note that this does not validate the method bodies, only the class structure.
  - validate
```
public void validate(java.util.List<ValidationException> exceptionList)
```
    Validates this SootClass for logical errors. Note that this does not validate the method bodies, only the class structure. All found errors are saved into the given list.

Class SootClass

Field Summary

Fields inherited from class soot.tagkit.AbstractHost

Constructor Summary

Method Summary

Methods inherited from class soot.tagkit.AbstractHost

Methods inherited from class java.lang.Object

Field Detail

name

shortName

fixedShortName

packageName

fixedPackageName

modifiers

fields

subSigToMethods

methodList

interfaces

isInScene

superClass

outerClass

isPhantom

INVOKEDYNAMIC_DUMMY_CLASS_NAME

DANGLING

HIERARCHY

SIGNATURES

BODIES

Constructor Detail

SootClass

SootClass

Method Detail

checkLevel

checkLevelIgnoreResolving

resolvingLevel

setResolvingLevel

isInScene

setInScene

getFieldCount

getFields

addField

removeField

getField

getFieldUnsafe

getFieldByName

getFieldByNameUnsafe

getField

getFieldUnsafe

declaresField

getMethod

getMethodUnsafe

declaresMethod

getMethod

getMethodUnsafe

declaresMethod

declaresFieldByName

declaresField

getMethodCount

methodIterator

getMethods

getMethod

getMethodUnsafe

getMethod

getMethodByNameUnsafe

getMethodByName

declaresMethod

declaresMethod

declaresMethodByName

addMethod

removeMethod

getModifiers

setModifiers

getInterfaceCount

getInterfaces

implementsInterface

addInterface

removeInterface

hasSuperclass

getSuperclass

setSuperclass

hasOuterClass