UnitThrowAnalysis (Soot - a J*va Optimization Framework 4.2.1 API)

java.lang.Object
- soot.toolkits.exceptions.AbstractThrowAnalysis
- - soot.toolkits.exceptions.UnitThrowAnalysis

All Implemented Interfaces:

ThrowAnalysis

Direct Known Subclasses:

DalvikThrowAnalysis
```
public class UnitThrowAnalysis
extends AbstractThrowAnalysis
```
A ThrowAnalysis which returns the set of runtime exceptions and errors that might be thrown by the bytecode instructions represented by a unit, as indicated by the Java Virtual Machine specification. I.e. this analysis is based entirely on the “opcode” of the unit, the types of its arguments, and the values of constant arguments.
The mightThrow methods could be declared static. They are left virtual to facilitate testing. For example, to verify that the expressions in a method call are actually being examined, a test case can override the mightThrow(SootMethod) with an implementation which returns the empty set instead of all possible exceptions.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class UnitThrowAnalysis.UnitSwitch

protected class UnitThrowAnalysis.ValueSwitch

Nested Classes
Modifier and Type	Class and Description
`protected class`	`UnitThrowAnalysis.UnitSwitch`
`protected class`	`UnitThrowAnalysis.ValueSwitch`

Field Summary

Fields
Modifier and Type	Field and Description
`static UnitThrowAnalysis`	`interproceduralAnalysis`
`protected boolean`	`isInterproc`
`protected com.google.common.cache.LoadingCache<SootMethod,ThrowableSet>`	`methodToThrowSet`
`protected ThrowableSet.Manager`	`mgr`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UnitThrowAnalysis()` A protected constructor for use by unit tests.
`protected`	`UnitThrowAnalysis(boolean isInterproc)`
	`UnitThrowAnalysis(Singletons.Global g)` Constructs a `UnitThrowAnalysis` for inclusion in Soot's global variable manager, `G`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ThrowableSet`	`defaultResult()`
`static UnitThrowAnalysis`	`interproc()`
`protected ThrowableSet`	`mightThrow(SootMethod sm)` Returns the set of types that might be thrown as a result of calling the specified method.
`protected ThrowableSet`	`mightThrow(SootMethodRef m)`
`ThrowableSet`	`mightThrow(Unit u)` Returns a set representing the `Throwable` types that the specified unit might throw.
`protected ThrowableSet`	`mightThrow(Value v)`
`ThrowableSet`	`mightThrowImplicitly(ThrowInst t)` Returns a set representing the `Throwable` types that the specified throw instruction might throw implicitly, that is, the possible types of errors which might arise in the course of executing the `throw` instruction, rather than the type of the `throw`'s operand.
`ThrowableSet`	`mightThrowImplicitly(ThrowStmt t)` Returns a set representing the `Throwable` types that the specified throw statement might throw implicitly, that is, the possible types of errors which might arise in the course of executing the `throw` statement, rather than the type of the `throw`'s operand.
`protected UnitThrowAnalysis.UnitSwitch`	`unitSwitch()`
`static UnitThrowAnalysis`	`v()` Returns the single instance of `UnitThrowAnalysis`.
`protected UnitThrowAnalysis.ValueSwitch`	`valueSwitch()`

Methods inherited from class soot.toolkits.exceptions.AbstractThrowAnalysis
mightThrowExplicitly, mightThrowExplicitly

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mgr
```
protected final ThrowableSet.Manager mgr
```
  - isInterproc
```
protected final boolean isInterproc
```
  - interproceduralAnalysis
```
public static UnitThrowAnalysis interproceduralAnalysis
```
  - methodToThrowSet
```
protected final com.google.common.cache.LoadingCache<SootMethod,ThrowableSet> methodToThrowSet
```
- Constructor Detail
  - UnitThrowAnalysis
```
public UnitThrowAnalysis(Singletons.Global g)
```
    Constructs a UnitThrowAnalysis for inclusion in Soot's global variable manager, G.
    
    Parameters:
    
    g - guarantees that the constructor may only be called from Singletons.
  - UnitThrowAnalysis
```
protected UnitThrowAnalysis()
```
    A protected constructor for use by unit tests.
  - UnitThrowAnalysis
```
protected UnitThrowAnalysis(boolean isInterproc)
```
- Method Detail
  - v
```
public static UnitThrowAnalysis v()
```
    Returns the single instance of UnitThrowAnalysis.
    
    Returns:
    
    Soot's UnitThrowAnalysis.
  - interproc
```
public static UnitThrowAnalysis interproc()
```
  - defaultResult
```
protected ThrowableSet defaultResult()
```
  - unitSwitch
```
protected UnitThrowAnalysis.UnitSwitch unitSwitch()
```
  - valueSwitch
```
protected UnitThrowAnalysis.ValueSwitch valueSwitch()
```
  - mightThrow
```
public ThrowableSet mightThrow(Unit u)
```
    Description copied from interface: ThrowAnalysis
    
    Returns a set representing the Throwable types that the specified unit might throw.
    
    Specified by:
    
    mightThrow in interface ThrowAnalysis
    
    Specified by:
    
    mightThrow in class AbstractThrowAnalysis
    
    Parameters:
    
    u - Unit whose exceptions are to be returned.
    
    Returns:
    
    a representation of the Throwable types that u might throw.
  - mightThrowImplicitly
```
public ThrowableSet mightThrowImplicitly(ThrowInst t)
```
    Description copied from interface: ThrowAnalysis
    
    Returns a set representing the Throwable types that the specified throw instruction might throw implicitly, that is, the possible types of errors which might arise in the course of executing the throw instruction, rather than the type of the throw's operand.
    
    Specified by:
    
    mightThrowImplicitly in interface ThrowAnalysis
    
    Specified by:
    
    mightThrowImplicitly in class AbstractThrowAnalysis
    
    Parameters:
    
    t - ThrowStmt whose implicit exceptions are to be returned.
    
    Returns:
    
    a representation of the types of exceptions that t might throw implicitly.
  - mightThrowImplicitly
```
public ThrowableSet mightThrowImplicitly(ThrowStmt t)
```
    Description copied from interface: ThrowAnalysis
    
    Returns a set representing the Throwable types that the specified throw statement might throw implicitly, that is, the possible types of errors which might arise in the course of executing the throw statement, rather than the type of the throw's operand.
    
    Specified by:
    
    mightThrowImplicitly in interface ThrowAnalysis
    
    Specified by:
    
    mightThrowImplicitly in class AbstractThrowAnalysis
    
    Parameters:
    
    t - ThrowStmt whose implicit exceptions are to be returned.
    
    Returns:
    
    a representation of the types of exceptions that t might throw implicitly.
  - mightThrow
```
protected ThrowableSet mightThrow(Value v)
```
  - mightThrow
```
protected ThrowableSet mightThrow(SootMethodRef m)
```
  - mightThrow
```
protected ThrowableSet mightThrow(SootMethod sm)
```
    Returns the set of types that might be thrown as a result of calling the specified method.
    
    Parameters:
    
    sm - method whose exceptions are to be returned.
    
    Returns:
    
    a representation of the set of Throwable types that m might throw.

Class UnitThrowAnalysis

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class soot.toolkits.exceptions.AbstractThrowAnalysis

Methods inherited from class java.lang.Object

Field Detail

mgr

isInterproc

interproceduralAnalysis

methodToThrowSet

Constructor Detail

UnitThrowAnalysis

UnitThrowAnalysis

UnitThrowAnalysis

Method Detail

v

interproc

defaultResult

unitSwitch

valueSwitch

mightThrow

mightThrowImplicitly

mightThrowImplicitly

mightThrow

mightThrow

mightThrow