Package sootup.core.model

Class SootMethod

java.lang.Object
sootup.core.model.SootClassMember<MethodSignature>
sootup.core.model.SootMethod
All Implemented Interfaces:
HasPosition, Method
Direct Known Subclasses:
JavaSootMethod
public class SootMethod extends SootClassMember<MethodSignature> implements Method
Soot's counterpart of the source language's method concept. 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.
Author:
Linghui Luo, Jan Martin Persch

  • Field Details

    • exceptions

      protected final @NonNull com.google.common.collect.ImmutableList<ClassType> exceptions
      Declared exceptions thrown by this method. Created upon demand.

    • bodySource

      protected final @NonNull BodySource bodySource
      Tells this method how to find out where its body lives.

  • Constructor Details

  • Method Details

    • isProtected

      public boolean isProtected()
      Description copied from class: SootClassMember
      Convenience method returning true if this class member is protected.
      Specified by:
      isProtected in class SootClassMember<MethodSignature>

    • isPrivate

      public boolean isPrivate()
      Description copied from class: SootClassMember
      Convenience method returning true if this class member is private.
      Specified by:
      isPrivate in class SootClassMember<MethodSignature>

    • isPublic

      public boolean isPublic()
      Description copied from class: SootClassMember
      Convenience method returning true if this class member is public.
      Specified by:
      isPublic in class SootClassMember<MethodSignature>

    • isStatic

      public boolean isStatic()
      Description copied from class: SootClassMember
      Convenience method returning true if this class member is static.
      Specified by:
      isStatic in class SootClassMember<MethodSignature>

    • isFinal

      public boolean isFinal()
      Description copied from class: SootClassMember
      Convenience method returning true if this field is final.
      Specified by:
      isFinal in class SootClassMember<MethodSignature>

    • getModifiers

      public @NonNull Set<MethodModifier> getModifiers()
      Gets the modifiers of this class member in an immutable set.
      See Also:

    • equivHashCode

      public int equivHashCode()
      Description copied from class: SootClassMember
      Returns a hash code for this method consistent with structural equality.
      Specified by:
      equivHashCode in class SootClassMember<MethodSignature>

    • isConcrete

      public boolean isConcrete()
      Returns true if this method is not abstract or native, i.e. this method can have a body.

    • getReturnType

      public @NonNull Type getReturnType()

    • getParameterCount

      public int getParameterCount()
      Returns the number of parameters taken by this method.

    • getParameterType

      public @NonNull Type getParameterType(int n)

    • getSubSignature

      public @NonNull MethodSubSignature getSubSignature()

    • getParameterTypes

      public @NonNull List<Type> getParameterTypes()

    • getDeclClassType

      public @NonNull ClassType getDeclClassType()

    • getName

      public @NonNull String getName()
      Overrides:
      getName in class SootClassMember<MethodSignature>

    • getBody

      public @NonNull Body getBody()
      Retrieves the active body for this method.

    • hasBody

      public boolean hasBody()
      Returns true if this method has a body.

    • getBodySource

      public @NonNull BodySource getBodySource()

    • getExceptionSignatures

      public @NonNull List<ClassType> getExceptionSignatures()

    • isAbstract

      public boolean isAbstract()
      Convenience method returning true if this method is abstract.

    • 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(@NonNull IdentifierFactory idf)
      Returns:
      yes if this is the main method

    • isConstructor

      public boolean isConstructor(@NonNull IdentifierFactory idf)
      Returns:
      true if the method is a constructor

    • isDefaultConstructor

      public boolean isDefaultConstructor(@NonNull IdentifierFactory idf)
      Returns:
      true if the method is the default constructor

    • toString

      public void toString(@NonNull StmtPrinter printer)
      Returns the declaration of this method, as used at the top of textual body representations (before the {}'s containing the code for representation.)

    • withOverridingMethodSource

      public @NonNull SootMethod withOverridingMethodSource(Function<OverridingBodySource,OverridingBodySource> overrider)
      Creates a new SootMethod based on a new OverridingBodySource. This is useful to change selected parts of a SootMethod without recreating a BodySource completely. OverridingBodySource allows for replacing the body of a method.

    • withSource

      public @NonNull SootMethod withSource(BodySource source)

    • withModifiers

      public @NonNull SootMethod withModifiers(Iterable<MethodModifier> modifiers)

    • withThrownExceptions

      public @NonNull SootMethod withThrownExceptions(Iterable<ClassType> thrownExceptions)

    • withBody

      public @NonNull SootMethod withBody(@NonNull Body body)

    • builder

      public static @NonNull SootMethod.MethodSourceStep builder()
      Creates a builder for SootMethods.
      Returns:
      A SootMethod.SootMethodBuilder.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object