From 32f5da54c628408c96db09d279f3a7ef44b3bd19 Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@mix.wvu.edu>
Date: Mon, 12 Feb 2018 22:19:02 -0500
Subject: Update

---
 .../bjc/utils/ioutils/blocks/BoundBlockReader.java | 42 ++++++++++++++++++----
 1 file changed, 35 insertions(+), 7 deletions(-)

(limited to 'base/src/main/java/bjc/utils/ioutils/blocks/BoundBlockReader.java')

diff --git a/base/src/main/java/bjc/utils/ioutils/blocks/BoundBlockReader.java b/base/src/main/java/bjc/utils/ioutils/blocks/BoundBlockReader.java
index b1e82d7..36e0ac1 100644
--- a/base/src/main/java/bjc/utils/ioutils/blocks/BoundBlockReader.java
+++ b/base/src/main/java/bjc/utils/ioutils/blocks/BoundBlockReader.java
@@ -5,24 +5,52 @@ import java.io.IOException;
 import java.util.function.BooleanSupplier;
 import java.util.function.Supplier;
 
+/**
+ * A block reader composed from functions.
+ * 
+ * @author EVE
+ *
+ */
 public class BoundBlockReader implements BlockReader {
+	/**
+	 * A function that serves to close an I/O source.
+	 * 
+	 * @author EVE
+	 *
+	 */
 	@FunctionalInterface
 	public interface Closer {
+		/**
+		 * Close the I/O source this is attached to.
+		 * 
+		 * @throws IOException
+		 *         If something goes wrong
+		 */
 		public void close() throws IOException;
 	}
 
-	private BooleanSupplier checker;
-	private Supplier<Block> getter;
-	private Closer          closer;
+	private BooleanSupplier	checker;
+	private Supplier<Block>	getter;
+	private Closer		closer;
 
 	private Block current;
 
 	private int blockNo;
 
+	/**
+	 * Create a new bound block reader.
+	 * 
+	 * @param blockChecker
+	 *        Predicate for checking if a block is available
+	 * @param blockGetter
+	 *        Function to retrieve a block
+	 * @param blockCloser
+	 *        Function to close a block source
+	 */
 	public BoundBlockReader(BooleanSupplier blockChecker, Supplier<Block> blockGetter, Closer blockCloser) {
 		checker = blockChecker;
-		getter  = blockGetter;
-		closer  = blockCloser;
+		getter = blockGetter;
+		closer = blockCloser;
 
 		blockNo = 0;
 	}
@@ -40,11 +68,11 @@ public class BoundBlockReader implements BlockReader {
 	@Override
 	public boolean nextBlock() {
 		if(checker.getAsBoolean()) {
-			current  = getter.get();
+			current = getter.get();
 			blockNo += 1;
 
 			return true;
-		} 
+		}
 
 		return false;
 	}
-- 
cgit v1.2.3