Class AstMethod

java.lang.Object

com.ibm.wala.cast.loader.AstMethod

All Implemented Interfaces:

IMember, IMethod, ContextItem, IClassHierarchyDweller

Direct Known Subclasses:

CAstAbstractModuleLoader.DynamicMethodObject, JavaSourceLoaderImpl.JavaEntityMethod

public abstract class AstMethod
extends Object
implements IMethod

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AstMethod.DebuggingInformation
static interface	AstMethod.LexicalInformation	lexical access information for some entity scope.
static class	AstMethod.LexicalParent	Parents of this method with respect to lexical scoping, that is, methods containing state possibly referenced lexically in this method
static interface	AstMethod.Retranslatable

Nested classes/interfaces inherited from interface ContextItem

ContextItem.Value<T>

Nested classes/interfaces inherited from interface IMethod

IMethod.SourcePosition

Field Summary

Fields

Modifier and Type	Field	Description
protected final IClass	cls

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AstMethod(IClass cls, Collection<CAstQualifier> qualifiers, AbstractCFG<?,?> cfg, SymbolTable symtab, MethodReference ref, boolean hasCatchBlock, Map<IBasicBlock<SSAInstruction>, TypeReference[]> caughtTypes, boolean hasMonitorOp, AstTranslator.AstLexicalInformation lexicalInfo, AstMethod.DebuggingInformation debugInfo, Collection<Annotation> annotations)
protected	AstMethod(IClass cls, Collection<CAstQualifier> qualifiers, MethodReference ref, Collection<Annotation> annotations)

Method Summary

Modifier and Type	Method	Description
Map<IBasicBlock<SSAInstruction>, TypeReference[]>	catchTypes()
AbstractCFG<?,?>	cfg()
AstMethod.LexicalInformation	cloneLexicalInfo()
AstMethod.DebuggingInformation	debugInfo()
Collection<Annotation>	getAnnotations()	Get the annotations on this member, if any
ControlFlowGraph<?,?>	getControlFlowGraph()
IClass	getDeclaringClass()	Return the object that represents the declaring class for this member.
Descriptor	getDescriptor()	something like: (IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
int	getLineNumber(int instructionIndex)
Atom	getName()
int	getNumberOfParameters()	Method getNumberOfParameters.
CAstSourcePositionMap.Position	getParameterPosition(int paramIndex)
IMethod.SourcePosition	getParameterSourcePosition(int paramNum)
abstract AstMethod.LexicalParent[]	getParents()
MethodReference	getReference()
TypeReference	getReturnType()
Selector	getSelector()	something like: foo(Ljava/langString;)Ljava/lang/Class;
String	getSignature()	something like: com.foo.bar.createLargeOrder(IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
CAstSourcePositionMap.Position	getSourcePosition()
CAstSourcePositionMap.Position	getSourcePosition(int instructionIndex)
boolean	hasExceptionHandler()
boolean	hasMonitorOp()
boolean	isAbstract()	Is this method abstract?
boolean	isAnnotation()
boolean	isBridge()	Is this method a bridge method? See JLS 3rd Edition 15.12.4.5
boolean	isClinit()	Is this method a class initializer?
boolean	isEnum()
boolean	isFinal()	Is this method final?
boolean	isInit()	Is this method an object initializer?
boolean	isModule()
boolean	isNative()	Is this method native?
boolean	isPrivate()	Is this method private?
boolean	isProtected()	Is this method protected?
boolean	isPublic()	Is this method public?
boolean	isStatic()	Is this member static?
boolean	isSynchronized()	Is this method synchronized?
boolean	isSynthetic()	Is this method synthetic, i.e., compiler-generated (this refers to the synthetic flag in java/dex bytecode)
boolean	isWalaSynthetic()	Is the implementation of this method a model generated by WALA? For compiler-generated synthetic methods, refer to IMethod.isSynthetic()
AstMethod.LexicalInformation	lexicalInfo()
SymbolTable	symbolTable()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IClassHierarchyDweller

getClassHierarchy

Methods inherited from interface IMethod

getDeclaredExceptions, getLocalVariableName, getNumberOfDefaultParameters, getParameterType, hasLocalVariableTable

Field Details

cls

protected final IClass cls

Constructor Details

AstMethod

protected AstMethod(IClass cls,
 Collection<CAstQualifier> qualifiers,
 AbstractCFG<?,?> cfg,
 SymbolTable symtab,
 MethodReference ref,
 boolean hasCatchBlock,
 Map<IBasicBlock<SSAInstruction>, TypeReference[]> caughtTypes,
 boolean hasMonitorOp,
 AstTranslator.AstLexicalInformation lexicalInfo,
 AstMethod.DebuggingInformation debugInfo,
 Collection<Annotation> annotations)

AstMethod

protected AstMethod(IClass cls,
 Collection<CAstQualifier> qualifiers,
 MethodReference ref,
 Collection<Annotation> annotations)

Method Details

cfg

public AbstractCFG<?,?> cfg()

symbolTable

public SymbolTable symbolTable()

catchTypes

public Map<IBasicBlock<SSAInstruction>, TypeReference[]> catchTypes()

cloneLexicalInfo

public AstMethod.LexicalInformation cloneLexicalInfo()

lexicalInfo

public AstMethod.LexicalInformation lexicalInfo()

debugInfo

public AstMethod.DebuggingInformation debugInfo()

getAnnotations

public Collection<Annotation> getAnnotations()

Description copied from interface: IMember

Get the annotations on this member, if any

Specified by:

getAnnotations in interface IMember

getParents

public abstract AstMethod.LexicalParent[] getParents()

getDeclaringClass

public IClass getDeclaringClass()

Description copied from interface: IMember

Return the object that represents the declaring class for this member.

Specified by:

getDeclaringClass in interface IMember

Returns:

the object that represents the declaring class for this member.

getSignature

public String getSignature()

Description copied from interface: IMethod

something like: com.foo.bar.createLargeOrder(IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;

Specified by:

getSignature in interface IMethod

getSelector

public Selector getSelector()

Description copied from interface: IMethod

something like: foo(Ljava/langString;)Ljava/lang/Class;

Specified by:

getSelector in interface IMethod

isClinit

public boolean isClinit()

Description copied from interface: IMethod

Is this method a class initializer?

Specified by:

isClinit in interface IMethod

isInit

public boolean isInit()

Description copied from interface: IMethod

Is this method an object initializer?

Specified by:

isInit in interface IMethod

getName

public Atom getName()

Specified by:

getName in interface IMember

Returns:

the name of this member

getDescriptor

public Descriptor getDescriptor()

Description copied from interface: IMethod

something like: (IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;

Specified by:

getDescriptor in interface IMethod

getReference

public MethodReference getReference()

Specified by:

getReference in interface IMethod

Returns:

canonical MethodReference corresponding to this method

getReturnType

public TypeReference getReturnType()

Specified by:

getReturnType in interface IMethod

Returns:

the name of the return type for this method

isStatic

public boolean isStatic()

Description copied from interface: IMember

Is this member static?

Specified by:

isStatic in interface IMember

isSynchronized

public boolean isSynchronized()

Description copied from interface: IMethod

Is this method synchronized?

Specified by:

isSynchronized in interface IMethod

isNative

public boolean isNative()

Description copied from interface: IMethod

Is this method native?

Specified by:

isNative in interface IMethod

isWalaSynthetic

public boolean isWalaSynthetic()

Description copied from interface: IMethod

Is the implementation of this method a model generated by WALA? For compiler-generated synthetic methods, refer to IMethod.isSynthetic()

Specified by:

isWalaSynthetic in interface IMethod

isSynthetic

public boolean isSynthetic()

Description copied from interface: IMethod

Is this method synthetic, i.e., compiler-generated (this refers to the synthetic flag in java/dex bytecode)

Specified by:

isSynthetic in interface IMethod

isAbstract

public boolean isAbstract()

Description copied from interface: IMethod

Is this method abstract?

Specified by:

isAbstract in interface IMethod

isPrivate

public boolean isPrivate()

Description copied from interface: IMethod

Is this method private?

Specified by:

isPrivate in interface IMethod

isProtected

public boolean isProtected()

Description copied from interface: IMethod

Is this method protected?

Specified by:

isProtected in interface IMethod

isAnnotation

public boolean isAnnotation()

Specified by:

isAnnotation in interface IMethod

isEnum

public boolean isEnum()

Specified by:

isEnum in interface IMethod

isModule

public boolean isModule()

Specified by:

isModule in interface IMethod

isPublic

public boolean isPublic()

Description copied from interface: IMethod

Is this method public?

Specified by:

isPublic in interface IMethod

isFinal

public boolean isFinal()

Description copied from interface: IMethod

Is this method final?

Specified by:

isFinal in interface IMethod

isBridge

public boolean isBridge()

Description copied from interface: IMethod

Is this method a bridge method? See JLS 3rd Edition 15.12.4.5

Specified by:

isBridge in interface IMethod

getControlFlowGraph

public ControlFlowGraph<?,?> getControlFlowGraph()

hasExceptionHandler

public boolean hasExceptionHandler()

Specified by:

hasExceptionHandler in interface IMethod

Returns:

true iff this method has at least one exception handler

hasMonitorOp

public boolean hasMonitorOp()

getNumberOfParameters

public int getNumberOfParameters()

Description copied from interface: IMethod

Method getNumberOfParameters. This result includes the "this" pointer if applicable

Specified by:

getNumberOfParameters in interface IMethod

getParameterSourcePosition

public IMethod.SourcePosition getParameterSourcePosition(int paramNum)
                                                  throws InvalidClassFileException

Specified by:

getParameterSourcePosition in interface IMethod

Throws:

InvalidClassFileException

getLineNumber

public int getLineNumber(int instructionIndex)

Specified by:

getLineNumber in interface IMethod

Returns:

the source line number corresponding to a particular bytecode index, or -1 if the information is not available.

getSourcePosition

public CAstSourcePositionMap.Position getSourcePosition()

getParameterPosition

public CAstSourcePositionMap.Position getParameterPosition(int paramIndex)

getSourcePosition

public CAstSourcePositionMap.Position getSourcePosition(int instructionIndex)

Specified by:

getSourcePosition in interface IMethod