SootMethod (Soot - a J*va Optimization Framework 4.6.0-SNAPSHOT API)

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

All Implemented Interfaces:

ClassMember, MethodOrMethodContext, SootMethodInterface, Host
```
public class SootMethod
extends AbstractHost
implements ClassMember, MethodOrMethodContext, SootMethodInterface
```
Soot representation of a Java method. Can be declared to belong to a SootClass. Does not contain the actual code, which belongs to a Body. The getActiveBody() method points to the currently-active body.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Body`	`activeBody` Active body associated with this method.
`static String`	`constructorName`
`protected SootClass`	`declaringClass` Holds the class which declares this `SootClass` method.
`protected List<SootClass>`	`exceptions` Declared exceptions thrown by this method.
`protected boolean`	`isDeclared` True when some `SootClass` object declares this `SootMethod` object.
`protected boolean`	`isPhantom` Is this method a phantom method?
`protected int`	`modifiers` Modifiers associated with this `SootMethod` (e.g.
`protected MethodSource`	`ms` Tells this method how to find out where its body lives.
`protected String`	`name` Name of the current method.
`protected Type[]`	`parameterTypes` An array of parameter types taken by this `SootMethod` object, in declaration order.
`protected Type`	`returnType` The return type of this object.
`protected String`	`sig`
`static String`	`staticInitializerName`
`protected String`	`subSig`
`protected NumberedString`	`subsignature`

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

Constructor Summary

Constructors
Constructor and Description
`SootMethod(String name, List<Type> parameterTypes, Type returnType)` Constructs a `SootMethod` with the given name, parameter types and return type.
`SootMethod(String name, List<Type> parameterTypes, Type returnType, int modifiers)` Constructs a `SootMethod` with the given name, parameter types, return type and modifiers.
`SootMethod(String name, List<Type> parameterTypes, Type returnType, int modifiers, List<SootClass> thrownExceptions)` Constructs a `SootMethod` with the given name, parameter types, return type, and list of thrown exceptions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addException(SootClass e)` Adds the given exception to the list of exceptions thrown by this method.
`void`	`addExceptionIfAbsent(SootClass e)` Adds the given exception to the list of exceptions thrown by this method unless the exception is already in the list.
`Context`	`context()`
`int`	`equivHashCode()` Returns a hash code for this method consistent with structural equality.
`Body`	`getActiveBody()` Retrieves the active body for this method.
`String`	`getBytecodeParms()` Returns the parameters part of the signature in the format in which it appears in bytecode.
`String`	`getBytecodeSignature()` Returns the signature of this method in the format in which it appears in bytecode (eg.
`String`	`getDavaDeclaration()`
`String`	`getDeclaration()` Returns the declaration of this method, as used at the top of textual body representations (before the {}'s containing the code for representation.)
`SootClass`	`getDeclaringClass()` Returns the class which declares the current `SootMethod`.
`List<SootClass>`	`getExceptions()` Returns a backed list of the exceptions thrown by this method.
`List<SootClass>`	`getExceptionsUnsafe()`
`int`	`getJavaSourceStartLineNumber()` Returns the Java source line number if available.
`int`	`getModifiers()` Gets the modifiers of this method.
`String`	`getName()` Returns the name of this method.
`NumberedString`	`getNumberedSubSignature()`
`int`	`getParameterCount()` Returns the number of parameters taken by this method.
`Type`	`getParameterType(int n)` Gets the type of the nth parameter of this method.
`List<Type>`	`getParameterTypes()` Returns a read-only list of the parameter types of this method.
`Type`	`getReturnType()` Returns the return type of this method.
`String`	`getSignature()` Returns the Soot signature of this method.
`static String`	`getSignature(SootClass cl, String subSignature)`
`static String`	`getSignature(SootClass cl, String name, List<Type> params, Type returnType)`
`MethodSource`	`getSource()` Returns the `MethodSource` of the current `SootMethod`.
`String`	`getSubSignature()` Returns the Soot subsignature of this method.
`static String`	`getSubSignature(String name, List<Type> params, Type returnType)`
`boolean`	`hasActiveBody()` Returns true if this method has an active body.
`boolean`	`isAbstract()` Convenience method returning true if this method is abstract.
`boolean`	`isConcrete()` Returns true if this method is not phantom, abstract or native, i.e.
`boolean`	`isConstructor()`
`boolean`	`isDeclared()` Returns true when some `SootClass` object declares this `SootMethod` object.
`boolean`	`isEntryMethod()`
`boolean`	`isFinal()` Convenience method returning true if this method is final.
`boolean`	`isJavaLibraryMethod()` We rely on the JDK class recognition to decide if a method is JDK method.
`boolean`	`isMain()`
`boolean`	`isNative()` Convenience method returning true if this method is native.
`boolean`	`isPhantom()` Returns true when this `SootMethod` object is phantom.
`boolean`	`isPrivate()` Convenience method returning true if this method is private.
`boolean`	`isProtected()` Convenience method returning true if this method is protected.
`boolean`	`isPublic()` Convenience method returning true if this method is public.
`boolean`	`isStatic()` Convenience method returning true if this method is static.
`boolean`	`isStaticInitializer()`
`boolean`	`isSynchronized()` Convenience method returning true if this method is synchronized.
`boolean`	`isValidResolve(SootMethodRef ref)`
`SootMethodRef`	`makeRef()`
`SootMethod`	`method()`
`void`	`releaseActiveBody()` Releases the active body associated with this method.
`void`	`removeException(SootClass e)` Removes the given exception from the list of exceptions thrown by this method.
`Body`	`retrieveActiveBody()` Returns the active body if present, else constructs an active body and returns that.
`Body`	`retrieveActiveBody(Consumer<Body> consumer)` Returns the active body if present, else constructs an active body, calls the consumer and returns the body afterward.
`void`	`setActiveBody(Body body)` Sets the active body for this method.
`void`	`setDeclared(boolean isDeclared)`
`void`	`setDeclaringClass(SootClass declClass)` Sets the declaring class
`void`	`setExceptions(List<SootClass> exceptions)`
`void`	`setModifiers(int modifiers)` Sets the modifiers of this method.
`void`	`setName(String name)` Sets the name of this method.
`void`	`setParameterTypes(List<Type> l)` Changes the set of parameter types of this method.
`void`	`setPhantom(boolean value)` Sets the phantom flag on this method.
`void`	`setReturnType(Type t)` Sets the return type of this method.
`void`	`setSource(MethodSource ms)` Sets the `MethodSource` of the current `SootMethod`.
`boolean`	`throwsException(SootClass e)` Returns true if this method throws exception `e`.
`String`	`toString()` Returns the signature of this method.

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

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

- Field Detail
  - constructorName
```
public static final String constructorName
```
    See Also:
    
    Constant Field Values
  - staticInitializerName
```
public static final String staticInitializerName
```
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
    Name of the current method.
  - parameterTypes
```
protected Type[] parameterTypes
```
    An array of parameter types taken by this SootMethod object, in declaration order.
  - returnType
```
protected Type returnType
```
    The return type of this object.
  - isDeclared
```
protected boolean isDeclared
```
    True when some SootClass object declares this SootMethod object.
  - declaringClass
```
protected SootClass declaringClass
```
    Holds the class which declares this SootClass method.
  - modifiers
```
protected int modifiers
```
    Modifiers associated with this SootMethod (e.g. private, protected, etc.)
  - isPhantom
```
protected boolean isPhantom
```
    Is this method a phantom method?
  - exceptions
```
protected List<SootClass> exceptions
```
    Declared exceptions thrown by this method. Created upon demand.
  - activeBody
```
protected volatile Body activeBody
```
    Active body associated with this method.
  - ms
```
protected volatile MethodSource ms
```
    Tells this method how to find out where its body lives.
  - sig
```
protected volatile String sig
```
  - subSig
```
protected volatile String subSig
```
  - subsignature
```
protected NumberedString subsignature
```
- Constructor Detail
  - SootMethod
```
public SootMethod(String name,
                  List<Type> parameterTypes,
                  Type returnType)
```
    Constructs a SootMethod with the given name, parameter types and return type.
  - SootMethod
```
public SootMethod(String name,
                  List<Type> parameterTypes,
                  Type returnType,
                  int modifiers)
```
    Constructs a SootMethod with the given name, parameter types, return type and modifiers.
  - SootMethod
```
public SootMethod(String name,
                  List<Type> parameterTypes,
                  Type returnType,
                  int modifiers,
                  List<SootClass> thrownExceptions)
```
    Constructs a SootMethod with the given name, parameter types, return type, and list of thrown exceptions.
- Method Detail
  - equivHashCode
```
public int equivHashCode()
```
    Returns a hash code for this method consistent with structural equality.
  - getName
```
public String getName()
```
    Returns the name of this method.
    
    Specified by:
    
    getName in interface SootMethodInterface
    
    Returns:
    
    Name of the method
  - setName
```
public void setName(String name)
```
    Sets the name of this method.
  - setDeclaringClass
```
public void setDeclaringClass(SootClass declClass)
```
    Sets the declaring class
  - getDeclaringClass
```
public SootClass getDeclaringClass()
```
    Returns the class which declares the current SootMethod.
    
    Specified by:
    
    getDeclaringClass in interface ClassMember
    
    Specified by:
    
    getDeclaringClass in interface SootMethodInterface
    
    Returns:
    
    The class which declares the current SootMethod/SootMethodRef
  - setDeclared
```
public void setDeclared(boolean isDeclared)
```
  - isDeclared
```
public boolean isDeclared()
```
    Returns true when some SootClass object declares this SootMethod object.
    
    Specified by:
    
    isDeclared in interface ClassMember
  - isPhantom
```
public boolean isPhantom()
```
    Returns true when this SootMethod object is phantom.
    
    Specified by:
    
    isPhantom in interface ClassMember
  - isConcrete
```
public boolean isConcrete()
```
    Returns true if this method is not phantom, abstract or native, i.e. this method can have a body.
  - setPhantom
```
public void setPhantom(boolean value)
```
    Sets the phantom flag on this method.
    
    Specified by:
    
    setPhantom in interface ClassMember
  - getModifiers
```
public int getModifiers()
```
    Gets the modifiers of this method.
    
    Specified by:
    
    getModifiers in interface ClassMember
    
    See Also:
    
    Modifier
  - setModifiers
```
public void setModifiers(int modifiers)
```
    Sets the modifiers of this method.
    
    Specified by:
    
    setModifiers in interface ClassMember
    
    See Also:
    
    Modifier
  - getReturnType
```
public Type getReturnType()
```
    Returns the return type of this method.
    
    Specified by:
    
    getReturnType in interface SootMethodInterface
  - setReturnType
```
public void setReturnType(Type t)
```
    Sets the return type of this method.
  - getParameterCount
```
public int getParameterCount()
```
    Returns the number of parameters taken by this method.
  - getParameterType
```
public Type getParameterType(int n)
```
    Gets the type of the nth parameter of this method.
    
    Specified by:
    
    getParameterType in interface SootMethodInterface
  - getParameterTypes
```
public List<Type> getParameterTypes()
```
    Returns a read-only list of the parameter types of this method.
    
    Specified by:
    
    getParameterTypes in interface SootMethodInterface
  - setParameterTypes
```
public void setParameterTypes(List<Type> l)
```
    Changes the set of parameter types of this method.
  - getSource
```
public MethodSource getSource()
```
    Returns the MethodSource of the current SootMethod.
  - setSource
```
public void setSource(MethodSource ms)
```
    Sets the MethodSource of the current SootMethod.
  - getActiveBody
```
public Body getActiveBody()
```
    Retrieves the active body for this method.
  - setActiveBody
```
public void setActiveBody(Body body)
```
    Sets the active body for this method.
  - retrieveActiveBody
```
public Body retrieveActiveBody()
```
    Returns the active body if present, else constructs an active body and returns that. If you called Scene.v().loadClassAndSupport() for a class yourself, it will not be an application class, so you cannot get retrieve its active body. Please call SootClass.setApplicationClass() on the relevant class.
  - retrieveActiveBody
```
public Body retrieveActiveBody(Consumer<Body> consumer)
```
    Returns the active body if present, else constructs an active body, calls the consumer and returns the body afterward. If you called Scene.v().loadClassAndSupport() for a class yourself, it will not be an application class, so you cannot get retrieve its active body. Please call SootClass.setApplicationClass() on the relevant class.
    
    Parameters:
    
    consumer - Consumer that takes in the body of the method. The consumer is only invoked if the current invocation constructs a new body and is guaranteed to terminate before the body is available to other threads.
    
    Returns:
    
    active body of the method
  - hasActiveBody
```
public boolean hasActiveBody()
```
    Returns true if this method has an active body.
  - releaseActiveBody
```
public void releaseActiveBody()
```
    Releases the active body associated with this method.
  - addExceptionIfAbsent
```
public void addExceptionIfAbsent(SootClass e)
```
    Adds the given exception to the list of exceptions thrown by this method unless the exception is already in the list.
  - addException
```
public void addException(SootClass e)
```
    Adds the given exception to the list of exceptions thrown by this method.
  - removeException
```
public void removeException(SootClass e)
```
    Removes the given exception from the list of exceptions thrown by this method.
  - throwsException
```
public boolean throwsException(SootClass e)
```
    Returns true if this method throws exception e.
  - setExceptions
```
public void setExceptions(List<SootClass> exceptions)
```
  - getExceptions
```
public List<SootClass> getExceptions()
```
    Returns a backed list of the exceptions thrown by this method.
  - getExceptionsUnsafe
```
public List<SootClass> getExceptionsUnsafe()
```
  - isStatic
```
public boolean isStatic()
```
    Convenience method returning true if this method is static.
    
    Specified by:
    
    isStatic in interface ClassMember
    
    Specified by:
    
    isStatic in interface SootMethodInterface
  - isPrivate
```
public boolean isPrivate()
```
    Convenience method returning true if this method is private.
    
    Specified by:
    
    isPrivate in interface ClassMember
  - isPublic
```
public boolean isPublic()
```
    Convenience method returning true if this method is public.
    
    Specified by:
    
    isPublic in interface ClassMember
  - isProtected
```
public boolean isProtected()
```
    Convenience method returning true if this method is protected.
    
    Specified by:
    
    isProtected in interface ClassMember
  - isAbstract
```
public boolean isAbstract()
```
    Convenience method returning true if this method is abstract.
  - isFinal
```
public boolean isFinal()
```
    Convenience method returning true if this method is final.
  - isNative
```
public boolean isNative()
```
    Convenience method returning true if this method is native.
  - isSynchronized
```
public boolean isSynchronized()
```
    Convenience method returning true if this method is synchronized.
  - isMain
```
public boolean isMain()
```
    Returns:
    
    yes if this is the main method
  - isConstructor
```
public boolean isConstructor()
```
    Returns:
    
    yes, if this function is a constructor. Please not that methods are not treated as constructors in this method.
  - isStaticInitializer
```
public boolean isStaticInitializer()
```
    Returns:
    
    yes, if this function is a static initializer.
  - isEntryMethod
```
public boolean isEntryMethod()
```
    Returns:
    
    yes, if this is a class initializer or main function.
  - isJavaLibraryMethod
```
public boolean isJavaLibraryMethod()
```
    We rely on the JDK class recognition to decide if a method is JDK method.
  - getBytecodeParms
```
public String getBytecodeParms()
```
    Returns the parameters part of the signature in the format in which it appears in bytecode.
  - getBytecodeSignature
```
public String getBytecodeSignature()
```
    Returns the signature of this method in the format in which it appears in bytecode (eg. [Ljava/lang/Object instead of java.lang.Object[]).
  - getSignature
```
public String getSignature()
```
    Returns the Soot signature of this method. Used to refer to methods unambiguously.
    
    Specified by:
    
    getSignature in interface SootMethodInterface
    
    Returns:
    
    The Soot signature of this method. Used to refer to methods unambiguously.
  - getSignature
```
public static String getSignature(SootClass cl,
                                  String name,
                                  List<Type> params,
                                  Type returnType)
```
  - getSignature
```
public static String getSignature(SootClass cl,
                                  String subSignature)
```
  - getSubSignature
```
public String getSubSignature()
```
    Returns the Soot subsignature of this method. Used to refer to methods unambiguously.
  - getSubSignature
```
public static String getSubSignature(String name,
                                     List<Type> params,
                                     Type returnType)
```
  - getNumberedSubSignature
```
public NumberedString getNumberedSubSignature()
```
  - toString
```
public String toString()
```
    Returns the signature of this method.
    
    Overrides:
    
    toString in class Object
  - getDavaDeclaration
```
public String getDavaDeclaration()
```
  - getDeclaration
```
public String getDeclaration()
```
    Returns the declaration of this method, as used at the top of textual body representations (before the {}'s containing the code for representation.)
  - method
```
public SootMethod method()
```
    Specified by:
    
    method in interface MethodOrMethodContext
  - context
```
public Context context()
```
    Specified by:
    
    context in interface MethodOrMethodContext
  - makeRef
```
public SootMethodRef makeRef()
```
  - isValidResolve
```
public boolean isValidResolve(SootMethodRef ref)
```
  - getJavaSourceStartLineNumber
```
public int getJavaSourceStartLineNumber()
```
    Description copied from interface: Host
    
    Returns the Java source line number if available. Returns -1 if not.
    
    Specified by:
    
    getJavaSourceStartLineNumber in interface Host
    
    Overrides:
    
    getJavaSourceStartLineNumber in class AbstractHost

Class SootMethod

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

constructorName

staticInitializerName

name

parameterTypes

returnType

isDeclared

declaringClass

modifiers

isPhantom

exceptions

activeBody

ms

sig

subSig

subsignature

Constructor Detail

SootMethod

SootMethod

SootMethod

Method Detail

equivHashCode

getName

setName

setDeclaringClass

getDeclaringClass

setDeclared

isDeclared

isPhantom

isConcrete

setPhantom

getModifiers

setModifiers

getReturnType

setReturnType

getParameterCount

getParameterType

getParameterTypes

setParameterTypes

getSource

setSource

getActiveBody

setActiveBody

retrieveActiveBody

retrieveActiveBody

hasActiveBody

releaseActiveBody

addExceptionIfAbsent

addException

removeException

throwsException

setExceptions

getExceptions

getExceptionsUnsafe

isStatic

isPrivate

isPublic

isProtected

isAbstract

isFinal

isNative

isSynchronized

isMain

isConstructor

isStaticInitializer

isEntryMethod

isJavaLibraryMethod

getBytecodeParms

getBytecodeSignature

getSignature

getSignature

getSignature

getSubSignature