From f67cf867c64b5cae8525e363501ea04f00686bc2 Mon Sep 17 00:00:00 2001
From: Jonathan Shook <jshook@gmail.com>
Date: Thu, 22 Feb 2024 12:01:27 -0600
Subject: [PATCH] nosqlbench-1841 Provide a binding function which traversed
 directory lines deterministically

---
 .../shared/from_long/to_string/DirectoryLinesStable.java    | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/virtdata-lib-basics/src/main/java/io/nosqlbench/virtdata/library/basics/shared/from_long/to_string/DirectoryLinesStable.java b/virtdata-lib-basics/src/main/java/io/nosqlbench/virtdata/library/basics/shared/from_long/to_string/DirectoryLinesStable.java
index e06bf2b27..a43e2a457 100644
--- a/virtdata-lib-basics/src/main/java/io/nosqlbench/virtdata/library/basics/shared/from_long/to_string/DirectoryLinesStable.java
+++ b/virtdata-lib-basics/src/main/java/io/nosqlbench/virtdata/library/basics/shared/from_long/to_string/DirectoryLinesStable.java
@@ -43,7 +43,11 @@ import java.util.regex.Pattern;
  * computed at initialization time. The content is assumed to be static during the lifetime of this function.
  * </P>
  * <p>
- * The value returned for a given cycle is stable, so long as the underlying data is stable.
+ * The value returned for a given cycle is stable, so long as the underlying data is stable.</P>
+ * <HR/>
+ * <P><EM>This caches all
+ * data at initialization time. If you need to buffer the data in stream mode, use {@link DirectoryLines} instead,
+ * which is not order-stable.</EM>
  * </P>
  */
 @ThreadSafeMapper