com.ibm.wala.ipa.cha

Class ClassHierarchy

java.lang.Object

com.ibm.wala.ipa.cha.ClassHierarchy

All Implemented Interfaces:

IClassHierarchy, Iterable<IClass>

public class ClassHierarchy
extends Object
implements IClassHierarchy

Simple implementation of a class hierarchy. Note that this class hierarchy implementation is mutable. You can add classes via addClass(). You can add a class even if c.getClassLoader() does not appear in getLoaders().

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addClass(IClass klass)
Collection<IClass>	computeSubClasses(TypeReference type) Return set of all subclasses of type in the Class Hierarchy TODO: Tune this implementation.
ClassLoaderFactory	getFactory()
Collection<IClass>	getImmediateSubclasses(IClass klass)
Set<IClass>	getImplementors(TypeReference type) TODO: tune this if necessary
Collection<TypeReference>	getJavaLangErrorTypes() Solely for optimization; return a Collection representing the subclasses of Error kind of ugly.
Collection<TypeReference>	getJavaLangRuntimeExceptionTypes() Solely for optimization; return a Collection representing the subclasses of RuntimeException kind of ugly.
IClass	getLeastCommonSuperclass(IClass a, IClass b)
TypeReference	getLeastCommonSuperclass(TypeReference a, TypeReference b)
IClassLoader	getLoader(ClassLoaderReference loaderRef)
IClassLoader[]	getLoaders()
int	getNumber(IClass c)
int	getNumberOfClasses()
int	getNumberOfImmediateSubclasses(IClass klass)
Set<IMethod>	getPossibleTargets(IClass declaredClass, MethodReference ref) Find the possible receivers of a call to a method reference
Set<IMethod>	getPossibleTargets(MethodReference ref) Find the possible targets of a call to a method reference.
IClass	getRootClass()
AnalysisScope	getScope()
Set<TypeReference>	getUnresolvedClasses() BEGIN Custom change: remember unresolved classes
boolean	implementsInterface(IClass c, IClass i) Does c implement i?
boolean	isAssignableFrom(IClass c1, IClass c2) Does an expression c1 x := c2 y typecheck? i.e.
boolean	isInterface(TypeReference type)
boolean	isRootClass(IClass c)
boolean	isSubclassOf(IClass c, IClass t) Is c a subclass of T?
Iterator<IClass>	iterator()
IClass	lookupClass(TypeReference a) Find a class in this class hierarchy.
static ClassHierarchy	make(AnalysisScope scope)
static ClassHierarchy	make(AnalysisScope scope, ClassLoaderFactory factory)
static ClassHierarchy	make(AnalysisScope scope, ClassLoaderFactory factory, Language language)
static ClassHierarchy	make(AnalysisScope scope, ClassLoaderFactory factory, Language language, com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor) temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor.
static ClassHierarchy	make(AnalysisScope scope, ClassLoaderFactory factory, com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor) temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor.
static ClassHierarchy	make(AnalysisScope scope, ClassLoaderFactory factory, Set<Language> languages)
static ClassHierarchy	make(AnalysisScope scope, com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor) temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor.
IField	resolveField(FieldReference f)
IField	resolveField(IClass klass, FieldReference f)
IMethod	resolveMethod(IClass receiverClass, Selector selector) Return the unique target of an invocation of method on an object of type declaringClass
IMethod	resolveMethod(MethodReference m) Return the unique receiver of an invocation of method on an object of type m.getDeclaredClass
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

addClass

public boolean addClass(IClass klass)

Specified by:

addClass in interface IClassHierarchy

Returns:

true if the add succeeded; false if it failed for some reason

Throws:

IllegalArgumentException - if klass is null

getPossibleTargets

public Set<IMethod> getPossibleTargets(MethodReference ref)

Find the possible targets of a call to a method reference. Note that if the reference is to an instance initialization method, we assume the method was called with invokespecial rather than invokevirtual.

Specified by:

getPossibleTargets in interface IClassHierarchy

Parameters:

ref - method reference

Returns:

the set of IMethods that this call can resolve to.

Throws:

IllegalArgumentException - if ref is null

getPossibleTargets

public Set<IMethod> getPossibleTargets(IClass declaredClass,
                              MethodReference ref)

Find the possible receivers of a call to a method reference

Specified by:

getPossibleTargets in interface IClassHierarchy

Parameters:

ref - method reference

declaredClass - the class of the receiver

Returns:

the set of IMethods that this call can resolve to.

resolveMethod

public IMethod resolveMethod(MethodReference m)

Return the unique receiver of an invocation of method on an object of type m.getDeclaredClass

Specified by:

resolveMethod in interface IClassHierarchy

Parameters:

m -

Returns:

IMethod, or null if no appropriate receiver is found.

Throws:

IllegalArgumentException - if m is null

resolveField

public IField resolveField(FieldReference f)

Specified by:

resolveField in interface IClassHierarchy

Returns:

the canonical IField that represents a given field , or null if none found

Throws:

IllegalArgumentException - if f is null

resolveField

public IField resolveField(IClass klass,
                  FieldReference f)

Specified by:

resolveField in interface IClassHierarchy

Returns:

the canonical IField that represents a given field , or null if none found

Throws:

IllegalArgumentException - if f is null

IllegalArgumentException - if klass is null

resolveMethod

public IMethod resolveMethod(IClass receiverClass,
                    Selector selector)

Return the unique target of an invocation of method on an object of type declaringClass

Specified by:

resolveMethod in interface IClassHierarchy

Parameters:

receiverClass - type of receiver

selector - method signature

Returns:

Method resolved method abstraction

Throws:

IllegalArgumentException - if receiverClass is null

toString

public String toString()

Overrides:

toString in class Object

getFactory

public ClassLoaderFactory getFactory()

Specified by:

getFactory in interface IClassHierarchy

getLeastCommonSuperclass

public IClass getLeastCommonSuperclass(IClass a,
                              IClass b)

Specified by:

getLeastCommonSuperclass in interface IClassHierarchy

Throws:

IllegalArgumentException - if A is null

getLeastCommonSuperclass

public TypeReference getLeastCommonSuperclass(TypeReference a,
                                     TypeReference b)

Specified by:

getLeastCommonSuperclass in interface IClassHierarchy

lookupClass

public IClass lookupClass(TypeReference a)

Find a class in this class hierarchy.

Specified by:

lookupClass in interface IClassHierarchy

Returns:

the IClass for a if found; null if can't find the class.

Throws:

IllegalArgumentException - if A is null

isSubclassOf

public boolean isSubclassOf(IClass c,
                   IClass t)

Is c a subclass of T?

Specified by:

isSubclassOf in interface IClassHierarchy

Throws:

IllegalArgumentException - if c is null

implementsInterface

public boolean implementsInterface(IClass c,
                          IClass i)

Does c implement i?

Specified by:

implementsInterface in interface IClassHierarchy

Returns:

true iff i is an interface and c is a class that implements i, or c is an interface that extends i.

computeSubClasses

public Collection<IClass> computeSubClasses(TypeReference type)

Return set of all subclasses of type in the Class Hierarchy TODO: Tune this implementation. Consider caching if necessary.

Specified by:

computeSubClasses in interface IClassHierarchy

getJavaLangErrorTypes

public Collection<TypeReference> getJavaLangErrorTypes()

Solely for optimization; return a Collection representing the subclasses of Error kind of ugly. a better scheme?

Specified by:

getJavaLangErrorTypes in interface IClassHierarchy

getJavaLangRuntimeExceptionTypes

public Collection<TypeReference> getJavaLangRuntimeExceptionTypes()

Solely for optimization; return a Collection representing the subclasses of RuntimeException kind of ugly. a better scheme?

Specified by:

getJavaLangRuntimeExceptionTypes in interface IClassHierarchy

isInterface

public boolean isInterface(TypeReference type)

Specified by:

isInterface in interface IClassHierarchy

getImplementors

public Set<IClass> getImplementors(TypeReference type)

TODO: tune this if necessary

Specified by:

getImplementors in interface IClassHierarchy

Parameters:

type - an interface

Returns:

Set of IClass that represent implementors of the interface

iterator

public Iterator<IClass> iterator()

Specified by:

iterator in interface Iterable<IClass>

getNumberOfClasses

public int getNumberOfClasses()

Specified by:

getNumberOfClasses in interface IClassHierarchy

Returns:

The number of classes present in the class hierarchy.

getLoaders

public IClassLoader[] getLoaders()

Specified by:

getLoaders in interface IClassHierarchy

getLoader

public IClassLoader getLoader(ClassLoaderReference loaderRef)

Specified by:

getLoader in interface IClassHierarchy

getScope

public AnalysisScope getScope()

Specified by:

getScope in interface IClassHierarchy

getNumberOfImmediateSubclasses

public int getNumberOfImmediateSubclasses(IClass klass)

Specified by:

getNumberOfImmediateSubclasses in interface IClassHierarchy

Returns:

the number of classes that immediately extend klass. if klass is an array class A[][]...[], we return number of immediate subclasses of A. If A is primitive, we return 0.

getImmediateSubclasses

public Collection<IClass> getImmediateSubclasses(IClass klass)

Specified by:

getImmediateSubclasses in interface IClassHierarchy

Parameters:

klass -

Returns:

the classes that immediately extend klass. if klass is an array class A[][]...[], we return array classes B[][]...[] (same dimensionality) where B is an immediate subclass of A. If A is primitive, we return the empty set.

make

public static ClassHierarchy make(AnalysisScope scope)
                           throws ClassHierarchyException

Returns:

a ClassHierarchy object representing the analysis scope

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor)
                           throws ClassHierarchyException

temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor.

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  ClassLoaderFactory factory)
                           throws ClassHierarchyException

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  ClassLoaderFactory factory,
                  com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor)
                           throws ClassHierarchyException

temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor.

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  ClassLoaderFactory factory,
                  Set<Language> languages)
                           throws ClassHierarchyException

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  ClassLoaderFactory factory,
                  Language language)
                           throws ClassHierarchyException

Throws:

ClassHierarchyException

make

public static ClassHierarchy make(AnalysisScope scope,
                  ClassLoaderFactory factory,
                  Language language,
                  com.ibm.wala.util.MonitorUtil.IProgressMonitor monitor)
                           throws ClassHierarchyException

temporarily marking this internal to avoid infinite sleep with randomly chosen IProgressMonitor. TODO: nanny for testgen

Throws:

ClassHierarchyException

getRootClass

public IClass getRootClass()

Specified by:

getRootClass in interface IClassHierarchy

isRootClass

public boolean isRootClass(IClass c)
                    throws IllegalArgumentException

Specified by:

isRootClass in interface IClassHierarchy

Throws:

IllegalArgumentException

getNumber

public int getNumber(IClass c)

Specified by:

getNumber in interface IClassHierarchy

isAssignableFrom

public boolean isAssignableFrom(IClass c1,
                       IClass c2)

Does an expression c1 x := c2 y typecheck? i.e. is c2 a subtype of c1?

Specified by:

isAssignableFrom in interface IClassHierarchy

Throws:

IllegalArgumentException - if c1 is null

IllegalArgumentException - if c2 is null

getUnresolvedClasses

public final Set<TypeReference> getUnresolvedClasses()

Description copied from interface: IClassHierarchy

BEGIN Custom change: remember unresolved classes

Specified by:

getUnresolvedClasses in interface IClassHierarchy