ML Security Top 10 aggregator check: JavaDoc.

Author: nuthub

plugins/carisma.check.mltop10checks/src/carisma/check/mltop10checks/aggregator/MLSecTop10Aggregator.java

@@ -63,20 +63,26 @@ public boolean perform(Map<String, CheckParameter> parameters, AnalysisHost host
 			this.host.appendLineToReport("Empty model");
 			return false;
 		}
-		// Package pkg = (Package) currentModel.getContents().get(0);
 
-		int id = 1;
-		for (CarismaCheckWithID check : checks) {
+		// Perform each check and collect results
+		for (int i = 0; i < checks.size(); i++) {
 			this.host.addResultMessage(new AnalysisResultMessage(StatusType.INFO, new String("---- ").repeat(20)));
 			this.host.addResultMessage(new AnalysisResultMessage(StatusType.INFO,
-					String.format("ML%1$02d", id++) + ":" + check.getName() + ":"));
-			results.put(check.getCheckID(), check.perform(this.parameters, this.host));
+					String.format("ML%1$02d", i + 1) + ":" + checks.get(i).getName() + ":"));
+			results.put(checks.get(i).getCheckID(), checks.get(i).perform(this.parameters, this.host));
 		}
 
 		// Overall result is successful, if there is no check that returned false.
 		return !results.containsValue(Boolean.FALSE);
 	}
 
+	/**
+	 * Return the list of all checks that should be included in this aggregator
+	 * check. Order matters, since the order determines the labels (ML01, ML02, ...,
+	 * ML10).
+	 * 
+	 * @return List of all checks that should be included in the aggregate report.
+	 */
 	private List<CarismaCheckWithID> initializeChecks() {
 		List<CarismaCheckWithID> checks = new ArrayList<>();
 		checks.add(new InputManipulationCheck());