From 2673f6a4c2649c299f1fbd340ffb8ac7315ad326 Mon Sep 17 00:00:00 2001
From: bculkin2442 <bjculkin@mix.wvu.edu>
Date: Mon, 6 Jan 2020 17:50:40 -0500
Subject: General warning cleanup

Just clean up of some warnings/other misc. problems
---
 .../java/bjc/utils/funcutils/IteratorUtils.java    | 33 +++++++++++++++++++++-
 .../main/java/bjc/utils/funcutils/TestUtils.java   |  9 ++++++
 2 files changed, 41 insertions(+), 1 deletion(-)

(limited to 'base/src/main/java/bjc/utils/funcutils')

diff --git a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
index 5242fc4..d691bab 100644
--- a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
@@ -12,12 +12,31 @@ import bjc.utils.data.*;
  *
  */
 public class IteratorUtils {
+	/**
+	 * A chain iterator. This is essentially flatMap in iterator form.
+	 * @author bjculkin
+	 *
+	 * @param <T1> 
+	 * 	The type of the input values.
+	 * 
+	 * @param <T2> 
+	 * 	The type of the output values.
+	 */
 	public static class ChainIterator<T1, T2> implements Iterator<T2> {
 		private Iterator<T1> mainItr;
 		private Function<T1, Iterator<T2>> trans;
 
 		private Iterator<T2> curItr;
 
+		/**
+		 * Create a new chain iterator.
+		 * 
+		 * @param mainItr
+		 * 	The main iterator for input.
+		 * 
+		 * @param trans
+		 * 	The transformation to use to produce the outputs.
+		 */
 		public ChainIterator(Iterator<T1> mainItr, Function<T1, Iterator<T2>> trans) {
 			this.mainItr = mainItr;
 			this.trans   = trans;
@@ -75,11 +94,23 @@ public class IteratorUtils {
 	 *
 	 * @return An iterator over the provided array.
 	 */
+	@SafeVarargs
 	public static <E> Iterator<E> AI(E... parms) {
 		return new ArrayIterator<>(parms);
 	}
 
+	/**
+	 * Create a chain iterator.
+	 * 
+	 * @param itrA
+	 * 	The iterator for input values.
+	 * 
+	 * @param itrB
+	 * 	The transformation for output values.
+	 * 
+	 * @return A chain iterator from the provided values.
+	 */
 	public static <A, B> Iterator<B> chain(Iterator<A> itrA, Function<A, Iterator<B>> itrB) {
-		return new ChainIterator(itrA, itrB);
+		return new ChainIterator<>(itrA, itrB);
 	}
 }
diff --git a/base/src/main/java/bjc/utils/funcutils/TestUtils.java b/base/src/main/java/bjc/utils/funcutils/TestUtils.java
index 586d366..c037ec4 100644
--- a/base/src/main/java/bjc/utils/funcutils/TestUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/TestUtils.java
@@ -52,6 +52,15 @@ public class TestUtils {
 		assertEquals(hasMore, src.hasNext());
 	}
 
+	/**
+	 * Assert that a list has a given set of contents.
+	 * 
+	 * @param src 
+	 * 	The list of actual elements.
+	 * 
+	 * @param exps
+	 * 	The list of expected elements.
+	 */
 	@SafeVarargs
 	public static <T> void assertListEquals(List<T> src, T... exps) {
 		assertEquals(exps.length, src.size());
-- 
cgit v1.2.3