Documentation

NationalSecurityAgency · Aug 29, 2024 · 05db63f · 05db63f
1 parent a6e735a
commit 05db63f
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/warehouse/core/src/main/java/datawave/iterators/IterationInterruptedException.java b/warehouse/core/src/main/java/datawave/iterators/IterationInterruptedException.java
@@ -1,7 +1,9 @@
 package datawave.iterators;
 
 /**
- * Exception thrown if an interrupt flag is detected.
+ * This code was repurposed from org.apache.accumulo.core.iteratorsImpl.system.IterationInterruptedException.
+ * It was not part of the public API, so we've created a DataWave equivalent.
+ * This exception should be used in place of {@link org.apache.accumulo.core.iteratorsImpl.system.IterationInterruptedException} when thrown from an iterator.
  */
 public class IterationInterruptedException extends RuntimeException {