Package crypto.reporting

Class ReporterHelper

java.lang.Object

crypto.reporting.ReporterHelper

public class ReporterHelper
extends Object

This class is used to generate a report as a String for multiple other classes. This class is used by the CommandLineReporter and TXTReporter.

Constructor Summary

Constructors

Constructor	Description
ReporterHelper()

Method Summary

Modifier and Type	Method	Description
static String	generateReport(List<CrySLRule> rules, Collection<IAnalysisSeed> objects, List<IAnalysisSeed> secureObjects, com.google.common.collect.Table<soot.SootClass,soot.SootMethod,Set<AbstractError>> errorMarkers, Map<Class<?>,Integer> errorMarkerCount, ReportStatistics statistics)	Generates an analysis report content for the CommandLineReporter and TXTReporter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReporterHelper

public ReporterHelper()

Method Detail

generateReport

public static String generateReport(List<CrySLRule> rules,
                                    Collection<IAnalysisSeed> objects,
                                    List<IAnalysisSeed> secureObjects,
                                    com.google.common.collect.Table<soot.SootClass,soot.SootMethod,Set<AbstractError>> errorMarkers,
                                    Map<Class<?>,Integer> errorMarkerCount,
                                    ReportStatistics statistics)

Generates an analysis report content for the CommandLineReporter and TXTReporter.

Parameters:

rules - A List with CrySLRule rules, which were used in the analysis

objects - A Collection with IAnalysisSeed objects

secureObjects - A List with IAnalysisSeed secureObjects

errorMarkers - A Table containing SootClass, SootMethod and a Set of AbstractError of the errors found during analysis

errorMarkerCount - A Map containing Class class of error and Integer number of errors

statistics - An instance of the class ReportStatistics, which holds all relevant statistics for the analysis. If no statistics should be included in the analysis, the value null should be passed.

Returns:

report The formatted analysis report as String