InfoflowResults (soot-infoflow 2.10.4 API)

java.lang.Object
- soot.jimple.infoflow.results.InfoflowResults

```
public class InfoflowResults
extends Object
```
Class for collecting information flow results

作者:

Steven Arzt

字段概要

字段
限定符和类型	字段和说明
`protected List<String>`	`exceptions`
`protected InfoflowPerformanceData`	`performanceData`
`protected soot.util.MultiMap<ResultSinkInfo,ResultSourceInfo>`	`results`
`static int`	`TERMINATION_DATA_FLOW_OOM`
`static int`	`TERMINATION_DATA_FLOW_TIMEOUT`
`static int`	`TERMINATION_PATH_RECONSTRUCTION_OOM`
`static int`	`TERMINATION_PATH_RECONSTRUCTION_TIMEOUT`
`static int`	`TERMINATION_SUCCESS`
`protected int`	`terminationState`

构造器概要

构造器
构造器和说明

InfoflowResults()

构造器
构造器和说明
`InfoflowResults()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addAll(InfoflowResults results)` Adds all results from the given data structure to this one
`void`	`addAll(Set<DataFlowResult> results)` Adds the given data flow results to this result object
`void`	`addException(String ex)` Adds an exception that has occurred during the data flow analysis to this result object
`void`	`addPerformanceData(InfoflowPerformanceData performanceData)` Adds the given performance data to this result object
`void`	`addResult(DataFlowResult res)` Adds the given data flow result to this data structure
`void`	`addResult(ISourceSinkDefinition sinkDefinition, AccessPath sink, soot.jimple.Stmt sinkStmt, ISourceSinkDefinition sourceDefinition, AccessPath source, soot.jimple.Stmt sourceStmt)`
`heros.solver.Pair<ResultSourceInfo,ResultSinkInfo>`	`addResult(ISourceSinkDefinition sinkDefinition, AccessPath sink, soot.jimple.Stmt sinkStmt, ISourceSinkDefinition sourceDefinition, AccessPath source, soot.jimple.Stmt sourceStmt, Object userData, List<Abstraction> propagationPath)`
`heros.solver.Pair<ResultSourceInfo,ResultSinkInfo>`	`addResult(ISourceSinkDefinition sinkDefinition, AccessPath sink, soot.jimple.Stmt sinkStmt, ISourceSinkDefinition sourceDefinition, AccessPath source, soot.jimple.Stmt sourceStmt, Object userData, List<soot.jimple.Stmt> propagationPath, List<AccessPath> propagationAccessPath)` Adds the given result to this data structure
`void`	`addResult(ResultSinkInfo sink, ResultSourceInfo source)` Adds the given result to this data structure
`void`	`clear()` Removes all results from the data structure
`boolean`	`containsSink(soot.jimple.Stmt sink)` Checks whether this result object contains a sink that exactly matches the given value.
`boolean`	`containsSinkMethod(String sinkSignature)` Checks whether this result object contains a sink with the given method signature
`boolean`	`equals(Object obj)`
`List<String>`	`getExceptions()` Gets the exceptions that have happened during the data flow analysis.
`InfoflowPerformanceData`	`getPerformanceData()` Gets the performance data on this FlowDroid run
`soot.util.MultiMap<ResultSinkInfo,ResultSourceInfo>`	`getResults()` Gets all results in this object as a hash map from sinks to sets of sources.
`Set<DataFlowResult>`	`getResultSet()` Gets the data flow results in a flat set
`int`	`getTerminationState()` Gets the termination state that describes whether the data flow analysis terminated normally or whether one or more phases terminated prematurely due to a timeout or an out-of-memory condition
`int`	`hashCode()`
`boolean`	`isEmpty()` Gets whether this result object is empty, i.e. contains no information flows
`boolean`	`isPathBetween(soot.jimple.Stmt sink, soot.jimple.Stmt source)` Checks whether there is a path between the given source and sink.
`boolean`	`isPathBetween(String sink, String source)` Checks whether there is a path between the given source and sink.
`boolean`	`isPathBetweenMethods(String sinkSignature, String sourceSignature)` Checks whether there is an information flow between the two given methods (specified by their respective Soot signatures).
`int`	`numConnections()` Gets the total number of source-to-sink connections.
`void`	`printResults()` Prints all results stored in this object to the standard output
`void`	`printResults(Writer wr)` Prints all results stored in this object to the given writer
`void`	`remove(DataFlowResult result)` Removes the given data flow result from this result set
`void`	`setPerformanceData(InfoflowPerformanceData performanceData)` Sets the performance data on this FlowDroid run
`void`	`setTerminationState(int terminationState)` Sets the termination state that describes whether the data flow analysis terminated normally or whether one or more phases terminated prematurely due to a timeout or an out-of-memory condition
`int`	`size()` Gets the number of entries in this result object
`String`	`toString()`
`boolean`	`wasAbortedTimeout()` Gets whether the analysis was aborted due to a timeout
`boolean`	`wasTerminatedOutOfMemory()` Gets whether the analysis was terminated because it ran out of memory

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - TERMINATION_SUCCESS
```
public static final int TERMINATION_SUCCESS
```
    另请参阅:
    
    常量字段值
  - TERMINATION_DATA_FLOW_TIMEOUT
```
public static final int TERMINATION_DATA_FLOW_TIMEOUT
```
    另请参阅:
    
    常量字段值
  - TERMINATION_DATA_FLOW_OOM
```
public static final int TERMINATION_DATA_FLOW_OOM
```
    另请参阅:
    
    常量字段值
  - TERMINATION_PATH_RECONSTRUCTION_TIMEOUT
```
public static final int TERMINATION_PATH_RECONSTRUCTION_TIMEOUT
```
    另请参阅:
    
    常量字段值
  - TERMINATION_PATH_RECONSTRUCTION_OOM
```
public static final int TERMINATION_PATH_RECONSTRUCTION_OOM
```
    另请参阅:
    
    常量字段值
  - results
```
protected volatile soot.util.MultiMap<ResultSinkInfo,ResultSourceInfo> results
```
  - performanceData
```
protected volatile InfoflowPerformanceData performanceData
```
  - exceptions
```
protected volatile List<String> exceptions
```
  - terminationState
```
protected int terminationState
```
- 构造器详细资料
  - InfoflowResults
```
public InfoflowResults()
```
- 方法详细资料
  - getExceptions
```
public List<String> getExceptions()
```
    Gets the exceptions that have happened during the data flow analysis. This collection is immutable.
    
    返回:
  - addException
```
public void addException(String ex)
```
    Adds an exception that has occurred during the data flow analysis to this result object
    
    参数:
    
    ex - The exception to add
  - size
```
public int size()
```
    Gets the number of entries in this result object
    
    返回:
    
    The number of entries in this result object
  - numConnections
```
public int numConnections()
```
    Gets the total number of source-to-sink connections. If there are two connections along different paths between the same source and sink, size() will return 1, but numConnections() will return 2.
    
    返回:
    
    The number of source-to-sink connections in this result object
  - isEmpty
```
public boolean isEmpty()
```
    Gets whether this result object is empty, i.e. contains no information flows
    
    返回:
    
    True if this result object is empty, otherwise false.
  - containsSink
```
public boolean containsSink(soot.jimple.Stmt sink)
```
    Checks whether this result object contains a sink that exactly matches the given value.
    
    参数:
    
    sink - The sink to check for
    
    返回:
    
    True if this result contains the given value as a sink, otherwise false.
  - containsSinkMethod
```
public boolean containsSinkMethod(String sinkSignature)
```
    Checks whether this result object contains a sink with the given method signature
    
    参数:
    
    sinkSignature - The method signature to check for
    
    返回:
    
    True if there is a sink with the given method signature in this result object, otherwise false.
  - addResult
```
public void addResult(ISourceSinkDefinition sinkDefinition,
                      AccessPath sink,
                      soot.jimple.Stmt sinkStmt,
                      ISourceSinkDefinition sourceDefinition,
                      AccessPath source,
                      soot.jimple.Stmt sourceStmt)
```
  - addResult
```
public heros.solver.Pair<ResultSourceInfo,ResultSinkInfo> addResult(ISourceSinkDefinition sinkDefinition,
                                                                    AccessPath sink,
                                                                    soot.jimple.Stmt sinkStmt,
                                                                    ISourceSinkDefinition sourceDefinition,
                                                                    AccessPath source,
                                                                    soot.jimple.Stmt sourceStmt,
                                                                    Object userData,
                                                                    List<Abstraction> propagationPath)
```
  - addResult
```
public heros.solver.Pair<ResultSourceInfo,ResultSinkInfo> addResult(ISourceSinkDefinition sinkDefinition,
                                                                    AccessPath sink,
                                                                    soot.jimple.Stmt sinkStmt,
                                                                    ISourceSinkDefinition sourceDefinition,
                                                                    AccessPath source,
                                                                    soot.jimple.Stmt sourceStmt,
                                                                    Object userData,
                                                                    List<soot.jimple.Stmt> propagationPath,
                                                                    List<AccessPath> propagationAccessPath)
```
    Adds the given result to this data structure
    
    参数:
    
    sinkDefinition - The definition of the sink
    
    sink - The access path that arrived at the sink statement
    
    sinkStmt - The sink statement
    
    sourceDefinition - The definition of the source
    
    source - The access path that originated from the source statement
    
    sourceStmt - The source statement
    
    userData - Optional user data to associate with the source
    
    propagationPath - The statements over which the data flow was propagated
    
    propagationAccessPath - The access paths along the data flow propagation path
    
    返回:
    
    The new data flow result
  - addResult
```
public void addResult(DataFlowResult res)
```
    Adds the given data flow result to this data structure
    
    参数:
    
    res - The data flow result to add
  - addResult
```
public void addResult(ResultSinkInfo sink,
                      ResultSourceInfo source)
```
    Adds the given result to this data structure
    
    参数:
    
    sink - The sink at which the taint arrived
    
    source - The source from which the taint originated
  - addAll
```
public void addAll(InfoflowResults results)
```
    Adds all results from the given data structure to this one
    
    参数:
    
    results - The data structure from which to copy the results
  - addAll
```
public void addAll(Set<DataFlowResult> results)
```
    Adds the given data flow results to this result object
    
    参数:
    
    results - The data flow results to add
  - getResults
```
public soot.util.MultiMap<ResultSinkInfo,ResultSourceInfo> getResults()
```
    Gets all results in this object as a hash map from sinks to sets of sources.
    
    返回:
    
    All results in this object as a hash map.
  - getResultSet
```
public Set<DataFlowResult> getResultSet()
```
    Gets the data flow results in a flat set
    
    返回:
    
    The data flow results in a flat set. If no data flows are available, the return value is null.
  - isPathBetween
```
public boolean isPathBetween(soot.jimple.Stmt sink,
                             soot.jimple.Stmt source)
```
    Checks whether there is a path between the given source and sink.
    
    参数:
    
    sink - The sink to which there may be a path
    
    source - The source from which there may be a path
    
    返回:
    
    True if there is a path between the given source and sink, false otherwise
  - isPathBetween
```
public boolean isPathBetween(String sink,
                             String source)
```
    Checks whether there is a path between the given source and sink.
    
    参数:
    
    sink - The sink to which there may be a path
    
    source - The source from which there may be a path
    
    返回:
    
    True if there is a path between the given source and sink, false otherwise
  - isPathBetweenMethods
```
public boolean isPathBetweenMethods(String sinkSignature,
                                    String sourceSignature)
```
    Checks whether there is an information flow between the two given methods (specified by their respective Soot signatures).
    
    参数:
    
    sinkSignature - The sink to which there may be a path
    
    sourceSignature - The source from which there may be a path
    
    返回:
    
    True if there is a path between the given source and sink, false otherwise
  - printResults
```
public void printResults()
```
    Prints all results stored in this object to the standard output
  - printResults
```
public void printResults(Writer wr)
                  throws IOException
```
    Prints all results stored in this object to the given writer
    
    参数:
    
    wr - The writer to which to print the results
    
    抛出:
    
    IOException - Thrown when data writing fails
  - clear
```
public void clear()
```
    Removes all results from the data structure
  - getTerminationState
```
public int getTerminationState()
```
    Gets the termination state that describes whether the data flow analysis terminated normally or whether one or more phases terminated prematurely due to a timeout or an out-of-memory condition
    
    返回:
    
    The termination state
  - setTerminationState
```
public void setTerminationState(int terminationState)
```
    Sets the termination state that describes whether the data flow analysis terminated normally or whether one or more phases terminated prematurely due to a timeout or an out-of-memory condition
    
    参数:
    
    terminationState - The termination state
  - wasAbortedTimeout
```
public boolean wasAbortedTimeout()
```
    Gets whether the analysis was aborted due to a timeout
    
    返回:
    
    True if the analysis was aborted due to a timeout, otherwise false
  - wasTerminatedOutOfMemory
```
public boolean wasTerminatedOutOfMemory()
```
    Gets whether the analysis was terminated because it ran out of memory
    
    返回:
    
    True if the analysis was terminated because it ran out of memory, otherwise false
  - getPerformanceData
```
public InfoflowPerformanceData getPerformanceData()
```
    Gets the performance data on this FlowDroid run
    
    返回:
    
    The performance data on this FlowDroid run
  - setPerformanceData
```
public void setPerformanceData(InfoflowPerformanceData performanceData)
```
    Sets the performance data on this FlowDroid run
    
    参数:
    
    performanceData - The performance data on this FlowDroid run
  - addPerformanceData
```
public void addPerformanceData(InfoflowPerformanceData performanceData)
```
    Adds the given performance data to this result object
    
    参数:
    
    performanceData - The performance data to add
  - remove
```
public void remove(DataFlowResult result)
```
    Removes the given data flow result from this result set
    
    参数:
    
    result - The result to remove
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 Object

类 InfoflowResults

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

TERMINATION_SUCCESS

TERMINATION_DATA_FLOW_TIMEOUT

TERMINATION_DATA_FLOW_OOM

TERMINATION_PATH_RECONSTRUCTION_TIMEOUT

TERMINATION_PATH_RECONSTRUCTION_OOM

results

performanceData

exceptions

terminationState

构造器详细资料

InfoflowResults

方法详细资料

getExceptions

addException

size

numConnections

isEmpty

containsSink

containsSinkMethod

addResult

addResult

addResult

addResult

addResult

addAll

addAll

getResults

getResultSet

isPathBetween

isPathBetween

isPathBetweenMethods

printResults

printResults

clear

getTerminationState

setTerminationState

wasAbortedTimeout

wasTerminatedOutOfMemory

getPerformanceData

setPerformanceData

addPerformanceData

remove

toString

hashCode

equals