From 0d4271a90b9f64c0c90e2fc87ecfd70c32b4961c Mon Sep 17 00:00:00 2001
From: Richard Cordovano <rcordovano@basistech.com>
Date: Fri, 18 Jul 2014 16:43:31 -0400
Subject: [PATCH] Add design comment to IngestModuleFactoryLoader

---
 .../autopsy/ingest/IngestModuleFactoryLoader.java    | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/Core/src/org/sleuthkit/autopsy/ingest/IngestModuleFactoryLoader.java b/Core/src/org/sleuthkit/autopsy/ingest/IngestModuleFactoryLoader.java
index 50889a1c9c..9c1341d9dd 100644
--- a/Core/src/org/sleuthkit/autopsy/ingest/IngestModuleFactoryLoader.java
+++ b/Core/src/org/sleuthkit/autopsy/ingest/IngestModuleFactoryLoader.java
@@ -54,6 +54,16 @@ final class IngestModuleFactoryLoader {
         return instance;
     }
 
+    /**
+     * Get the currently available set of ingest module factories. The factories
+     * are not cached between calls since NetBeans modules with classes labeled
+     * as IngestModuleFactory service providers and/or Python scripts defining
+     * classes derived from IngestModuleFactory may be added or removed between
+     * invocations.
+     *
+     * @return A list of objects that implement the IngestModuleFactory
+     * interface.
+     */
     synchronized List<IngestModuleFactory> getIngestModuleFactories() {
         // Discover the ingest module factories, making sure that there are no
         // duplicate module display names. The duplicates requirement could be
@@ -109,4 +119,4 @@ final class IngestModuleFactoryLoader {
 
         return orderedModuleFactories;
     }
-}
\ No newline at end of file
+}