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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SootMethod.BuildStep
static interface	SootMethod.MethodSourceStep
static interface	SootMethod.ModifierStep
static interface	SootMethod.SignatureStep
static class	SootMethod.SootMethodBuilder	Defines a SootMethod builder that provides a fluent API.
static interface	SootMethod.ThrownExceptionsStep

Field Summary

Fields

Modifier and Type	Field	Description
protected final BodySource	bodySource	Tells this method how to find out where its body lives.
protected final com.google.common.collect.ImmutableList<ClassType>	exceptions	Declared exceptions thrown by this method.
protected final com.google.common.collect.ImmutableList<Type>	parameterTypes	An array of parameter types taken by this SootMethod object, in declaration order.

Constructor Summary

Constructors

Constructor	Description
SootMethod(BodySource source, MethodSignature methodSignature, Iterable<MethodModifier> modifiers, Iterable<ClassType> thrownExceptions, Position position)	Constructs a SootMethod object with the given attributes.

Method Summary

Modifier and Type	Method	Description
static SootMethod.MethodSourceStep	builder()	Creates a builder for SootMethods.
boolean	equals(Object obj)
int	equivHashCode()	Returns a hash code for this method consistent with structural equality.
Body	getBody()	Retrieves the active body for this method.
BodySource	getBodySource()
List<ClassType>	getExceptionSignatures()
Set<MethodModifier>	getModifiers()	Gets the modifiers of this class member in an immutable set.
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()
boolean	hasBody()	Returns true if this method has a body.
int	hashCode()
boolean	isAbstract()	Convenience method returning true if this method is abstract.
boolean	isConcrete()	Returns true if this method is not abstract or native, i.e.
boolean	isFinal()	Convenience method returning true if this field is final.
boolean	isMain(IdentifierFactory idf)
boolean	isNative()	Convenience method returning true if this method is native.
boolean	isPrivate()	Convenience method returning true if this class member is private.
boolean	isProtected()	Convenience method returning true if this class member is protected.
boolean	isPublic()	Convenience method returning true if this class member is public.
boolean	isStatic()	Convenience method returning true if this class member is static.
boolean	isSynchronized()	Convenience method returning true if this method is synchronized.
void	toString(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.)
SootMethod	withBody(Body body)
SootMethod	withModifiers(Iterable<MethodModifier> modifiers)
SootMethod	withOverridingMethodSource(Function<OverridingBodySource,OverridingBodySource> overrider)	Creates a new SootMethod based on a new OverridingBodySource.
SootMethod	withSource(BodySource source)
SootMethod	withThrownExceptions(Iterable<ClassType> thrownExceptions)

Methods inherited from class sootup.core.model.SootClassMember

getDeclaringClassType, getName, getPosition, getSignature, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface sootup.core.model.Method

getSignature

Field Details

parameterTypes

@Nonnull
protected final com.google.common.collect.ImmutableList<Type> parameterTypes

An array of parameter types taken by this SootMethod object, in declaration order.

exceptions

@Nonnull
protected final com.google.common.collect.ImmutableList<ClassType> exceptions

Declared exceptions thrown by this method. Created upon demand.

bodySource

@Nonnull
protected final BodySource bodySource

Tells this method how to find out where its body lives.

Constructor Details

SootMethod

public SootMethod(@Nonnull
 BodySource source,
 @Nonnull
 MethodSignature methodSignature,
 @Nonnull
 Iterable<MethodModifier> modifiers,
 @Nonnull
 Iterable<ClassType> thrownExceptions,
 @Nonnull
 Position position)

Constructs a SootMethod object with the given attributes.

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

@Nonnull
public Set<MethodModifier> getModifiers()

Gets the modifiers of this class member in an immutable set.

See Also:

• MethodModifier

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

@Nonnull
public Type getReturnType()

getParameterCount

public int getParameterCount()

Returns the number of parameters taken by this method.

getParameterType

@Nonnull
public Type getParameterType(int n)

Gets the type of the nth parameter of this method.

getParameterTypes

@Nonnull
public List<Type> getParameterTypes()

Returns a read-only list of the parameter types of this method.

getBody

@Nonnull
public Body getBody()

Retrieves the active body for this method.

hasBody

public boolean hasBody()

Returns true if this method has a body.

getBodySource

@Nonnull
public BodySource getBodySource()

getExceptionSignatures

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

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

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

@Nonnull
public SootMethod withSource(BodySource source)

withModifiers

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

withThrownExceptions

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

withBody

@Nonnull
public SootMethod withBody(@Nonnull
 Body body)

builder

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