Package sootup.java.core

Class JavaSootMethod

java.lang.Object

sootup.core.model.SootClassMember<MethodSignature>

sootup.java.core.JavaSootMethod

All Implemented Interfaces:

HasPosition, Method, SootMethod, HasAnnotation

public class JavaSootMethod
extends SootClassMember<MethodSignature>
implements SootMethod, HasAnnotation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaSootMethod.JavaSootMethodBuilder	Defines a JavaSootMethod.JavaSootMethodBuilder to provide a fluent API.

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull BodySource	bodySource	Tells this method how to find out where its body lives.
protected final @NonNull com.google.common.collect.ImmutableList<ClassType>	exceptions	Declared exceptions thrown by this method.

Fields inherited from class sootup.core.model.SootClassMember

position, signature

Constructor Summary

Constructors

Constructor	Description
JavaSootMethod(@NonNull BodySource source, @NonNull MethodSignature methodSignature, @NonNull Iterable<MethodModifier> modifiers, @NonNull Iterable<ClassType> thrownExceptions, @NonNull Iterable<AnnotationUsage> annotations, @NonNull Position position)
JavaSootMethod(@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 Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	equivHashCode()	Returns a hash code for this method consistent with structural equality.
@NonNull Iterable<AnnotationUsage>	getAnnotations()
@NonNull Body	getBody()	Retrieves the active body for this method.
@NonNull BodySource	getBodySource()
@NonNull ClassType	getDeclaringClassType()	Returns the SootClass declaring this one.
@NonNull ClassType	getDeclClassType()
@NonNull Optional<Object>	getDefaultValue()
@NonNull List<ClassType>	getExceptionSignatures()
@NonNull Set<MethodModifier>	getModifiers()	Gets the modifiers of this class member in an immutable set.
@NonNull String	getName()
int	getParameterCount()	Returns the number of parameters taken by this method.
@NonNull Type	getParameterType(int n)
@NonNull List<Type>	getParameterTypes()
@NonNull Type	getReturnType()
@NonNull MethodSubSignature	getSubSignature()
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. this method can have a body.
boolean	isConstructor(@NonNull IdentifierFactory idf)
boolean	isDefaultConstructor(@NonNull IdentifierFactory idf)
boolean	isFinal()	Convenience method returning true if this field is final.
boolean	isMain(@NonNull 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(@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.)
@NonNull JavaSootMethod	withAnnotations(@NonNull Iterable<AnnotationUsage> annotations)
@NonNull JavaSootMethod	withBody(@NonNull Body body)
@NonNull JavaSootMethod	withModifiers(@NonNull Iterable<MethodModifier> modifiers)
@NonNull JavaSootMethod	withOverridingMethodSource(@NonNull Function<OverridingBodySource,OverridingBodySource> overrider)	Creates a new SootMethod based on a new OverridingBodySource.
@NonNull JavaSootMethod	withSource(@NonNull BodySource source)
@NonNull JavaSootMethod	withThrownExceptions(@NonNull Iterable<ClassType> thrownExceptions)

Methods inherited from class sootup.core.model.SootClassMember

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.SootMethod

getPosition, getSignature

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

JavaSootMethod

public JavaSootMethod(@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.

JavaSootMethod

public JavaSootMethod(@NonNull BodySource source,
 @NonNull MethodSignature methodSignature,
 @NonNull Iterable<MethodModifier> modifiers,
 @NonNull Iterable<ClassType> thrownExceptions,
 @NonNull Iterable<AnnotationUsage> annotations,
 @NonNull Position position)

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 interface SootMethod

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 interface SootMethod

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 interface SootMethod

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 interface SootMethod

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 interface SootMethod

Specified by:

isFinal in class SootClassMember<MethodSignature>

getModifiers

public @NonNull Set<MethodModifier> getModifiers()

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

Specified by:

getModifiers in interface SootMethod

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.

Specified by:

isConcrete in interface SootMethod

getReturnType

public @NonNull Type getReturnType()

Specified by:

getReturnType in interface SootMethod

getParameterCount

public int getParameterCount()

Returns the number of parameters taken by this method.

Specified by:

getParameterCount in interface SootMethod

getParameterType

public @NonNull Type getParameterType(int n)

Specified by:

getParameterType in interface SootMethod

getSubSignature

public @NonNull MethodSubSignature getSubSignature()

Specified by:

getSubSignature in interface SootMethod

getParameterTypes

public @NonNull List<Type> getParameterTypes()

Specified by:

getParameterTypes in interface SootMethod

getDeclClassType

public @NonNull ClassType getDeclClassType()

Specified by:

getDeclClassType in interface SootMethod

getDeclaringClassType

public @NonNull ClassType getDeclaringClassType()

Returns the SootClass declaring this one.

Specified by:

getDeclaringClassType in interface SootMethod

Overrides:

getDeclaringClassType in class SootClassMember<MethodSignature>

getName

public @NonNull String getName()

Specified by:

getName in interface SootMethod

Overrides:

getName in class SootClassMember<MethodSignature>

getBody

public @NonNull Body getBody()

Retrieves the active body for this method.

Specified by:

getBody in interface SootMethod

hasBody

public boolean hasBody()

Returns true if this method has a body.

Specified by:

hasBody in interface SootMethod

getBodySource

public @NonNull BodySource getBodySource()

Specified by:

getBodySource in interface SootMethod

getExceptionSignatures

public @NonNull List<ClassType> getExceptionSignatures()

Specified by:

getExceptionSignatures in interface SootMethod

isAbstract

public boolean isAbstract()

Convenience method returning true if this method is abstract.

Specified by:

isAbstract in interface SootMethod

isNative

public boolean isNative()

Convenience method returning true if this method is native.

Specified by:

isNative in interface SootMethod

isSynchronized

public boolean isSynchronized()

Convenience method returning true if this method is synchronized.

Specified by:

isSynchronized in interface SootMethod

isMain

public boolean isMain(@NonNull IdentifierFactory idf)

Specified by:

isMain in interface SootMethod

Returns:

yes if this is the main method

isConstructor

public boolean isConstructor(@NonNull IdentifierFactory idf)

Specified by:

isConstructor in interface SootMethod

Returns:

true if the method is a constructor

isDefaultConstructor

public boolean isDefaultConstructor(@NonNull IdentifierFactory idf)

Specified by:

isDefaultConstructor in interface SootMethod

Returns:

true if the method is the default constructor

getDefaultValue

public @NonNull Optional<Object> getDefaultValue()

Returns:

returns default value of annotation. May be null, if there is no default value

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.)

Specified by:

toString in interface SootMethod

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAnnotations

public @NonNull Iterable<AnnotationUsage> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotation

withOverridingMethodSource

public @NonNull JavaSootMethod withOverridingMethodSource(@NonNull 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.

Specified by:

withOverridingMethodSource in interface SootMethod

withSource

public @NonNull JavaSootMethod withSource(@NonNull BodySource source)

Specified by:

withSource in interface SootMethod

withModifiers

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

Specified by:

withModifiers in interface SootMethod

withThrownExceptions

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

Specified by:

withThrownExceptions in interface SootMethod

withAnnotations

public @NonNull JavaSootMethod withAnnotations(@NonNull Iterable<AnnotationUsage> annotations)

withBody

public @NonNull JavaSootMethod withBody(@NonNull Body body)

Specified by:

withBody in interface SootMethod