Cleanup some warnings and stuff

14 files changed, 153 insertions, 21 deletions

diff --git a/base/src/main/java/bjc/utils/exceptions/NonConstantPower.java b/base/src/main/java/bjc/utils/exceptions/NonConstantPower.java
index 143fb4d..15367dc 100644
--- a/base/src/main/java/bjc/utils/exceptions/NonConstantPower.java
+++ b/base/src/main/java/bjc/utils/exceptions/NonConstantPower.java
@@ -1,8 +1,17 @@
 package bjc.utils.exceptions;
 
+/**
+ * Exception thrown when using a non-constant power.
+ * 
+ * @author Ben Culkin
+ *
+ */
 public class NonConstantPower extends RuntimeException {
 	private static final long serialVersionUID = 1640883448305031149L;
 
+	/**
+	 * Create a new non-constant power exception.
+	 */
 	public NonConstantPower() {
 		super("Cannot raise an expression to a non-constant power");
 	}
diff --git a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
index a97e876..8d51996 100644
--- a/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/IteratorUtils.java
@@ -46,10 +46,7 @@ public class IteratorUtils {
 		@Override
 		public boolean hasNext() {
 			if (curItr != null) {
-				if (curItr.hasNext())
-					return true;
-				else
-					return mainItr.hasNext();
+				return curItr.hasNext() ? true : mainItr.hasNext();
 			}
 
 			return mainItr.hasNext();
diff --git a/base/src/main/java/bjc/utils/ioutils/ReportWriter.java b/base/src/main/java/bjc/utils/ioutils/ReportWriter.java
index 95a7f6d..3815f25 100644
--- a/base/src/main/java/bjc/utils/ioutils/ReportWriter.java
+++ b/base/src/main/java/bjc/utils/ioutils/ReportWriter.java
@@ -416,6 +416,10 @@ public class ReportWriter extends Writer {
 		return rw;
 	}
 
+	
+	/**
+	 * Create a new report writer that writes to a new blank string writer.
+	 */
 	public ReportWriter() {
 		this(new StringWriter());
 	}
diff --git a/base/src/main/java/bjc/utils/ioutils/SimpleProperties.java b/base/src/main/java/bjc/utils/ioutils/SimpleProperties.java
index be8cda7..e035894 100644
--- a/base/src/main/java/bjc/utils/ioutils/SimpleProperties.java
+++ b/base/src/main/java/bjc/utils/ioutils/SimpleProperties.java
@@ -37,9 +37,18 @@ public class SimpleProperties implements Map<String, String> {
 		}
 	}
 
+	/**
+	 * Exception thrown when a line is formattted incorrectly.
+	 * @author Ben Culkin
+	 *
+	 */
 	public static class InvalidLineFormat extends RuntimeException {
 		private static final long serialVersionUID = 5332131472090792841L;
 
+		/**
+		 * Create a new exception for an incorrectly formatted line.
+		 * @param lne The line that was incorrectly formatted.
+		 */
 		public InvalidLineFormat(String lne) {
 			super(String.format(
 					"Line '%s' is improperly formatted.\n\tExpected format is a string key, followed by a single space, followed by the value",
diff --git a/base/src/test/java/bjc/utils/test/ioutils/SimplePropertiesTest.java b/base/src/test/java/bjc/utils/test/ioutils/SimplePropertiesTest.java
index 9de2ad3..5f166ab 100644
--- a/base/src/test/java/bjc/utils/test/ioutils/SimplePropertiesTest.java
+++ b/base/src/test/java/bjc/utils/test/ioutils/SimplePropertiesTest.java
@@ -16,8 +16,8 @@ import bjc.utils.ioutils.SimpleProperties.InvalidLineFormat;
  * @author Ben Culkin
  *
  */
+@SuppressWarnings("javadoc")
 public class SimplePropertiesTest {
-
 	@Test
 	public void testSimpleProperties() {
 		SimpleProperties props = new SimpleProperties();
diff --git a/base/src/test/java/bjc/utils/test/math/NumberUtilsTest.java b/base/src/test/java/bjc/utils/test/math/NumberUtilsTest.java
index 47c264f..ca1e111 100644
--- a/base/src/test/java/bjc/utils/test/math/NumberUtilsTest.java
+++ b/base/src/test/java/bjc/utils/test/math/NumberUtilsTest.java
@@ -6,6 +6,7 @@ import org.junit.Test;
 
 import bjc.utils.math.NumberUtils;
 
+@SuppressWarnings("javadoc")
 public class NumberUtilsTest {
 
 	@Test
diff --git a/clformat/.settings/org.eclipse.jdt.core.prefs b/clformat/.settings/org.eclipse.jdt.core.prefs
index 2f5cc74..83dd9b0 100644
--- a/clformat/.settings/org.eclipse.jdt.core.prefs
+++ b/clformat/.settings/org.eclipse.jdt.core.prefs
@@ -1,8 +1,109 @@
 eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.annotation.inheritNullAnnotations=disabled
+org.eclipse.jdt.core.compiler.annotation.missingNonNullByDefaultAnnotation=ignore
+org.eclipse.jdt.core.compiler.annotation.nonnull=org.eclipse.jdt.annotation.NonNull
+org.eclipse.jdt.core.compiler.annotation.nonnull.secondary=
+org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annotation.NonNullByDefault
+org.eclipse.jdt.core.compiler.annotation.nonnullbydefault.secondary=
+org.eclipse.jdt.core.compiler.annotation.nullable=org.eclipse.jdt.annotation.Nullable
+org.eclipse.jdt.core.compiler.annotation.nullable.secondary=
+org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
 org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.APILeak=warning
+org.eclipse.jdt.core.compiler.problem.annotatedTypeArgumentToUnannotated=info
+org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
+org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
+org.eclipse.jdt.core.compiler.problem.comparingIdentical=warning
+org.eclipse.jdt.core.compiler.problem.deadCode=warning
+org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
+org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
+org.eclipse.jdt.core.compiler.problem.discouragedReference=warning
+org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore
 org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
+org.eclipse.jdt.core.compiler.problem.explicitlyClosedAutoCloseable=ignore
+org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
+org.eclipse.jdt.core.compiler.problem.fatalOptionalError=disabled
+org.eclipse.jdt.core.compiler.problem.fieldHiding=info
+org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
+org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
 org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
+org.eclipse.jdt.core.compiler.problem.includeNullInfoFromAsserts=enabled
+org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
+org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=info
+org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
+org.eclipse.jdt.core.compiler.problem.missingDefaultCase=info
+org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingEnumCaseDespiteDefault=disabled
+org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=ignore
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=info
+org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled
+org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
+org.eclipse.jdt.core.compiler.problem.missingSynchronizedOnInheritedMethod=ignore
+org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
+org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning
+org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore
+org.eclipse.jdt.core.compiler.problem.nonnullParameterAnnotationDropped=warning
+org.eclipse.jdt.core.compiler.problem.nonnullTypeVariableFromLegacyInvocation=warning
+org.eclipse.jdt.core.compiler.problem.nullAnnotationInferenceConflict=error
+org.eclipse.jdt.core.compiler.problem.nullReference=warning
+org.eclipse.jdt.core.compiler.problem.nullSpecViolation=error
+org.eclipse.jdt.core.compiler.problem.nullUncheckedConversion=warning
+org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
+org.eclipse.jdt.core.compiler.problem.parameterAssignment=warning
+org.eclipse.jdt.core.compiler.problem.pessimisticNullAnalysisForFreeTypeVariables=warning
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=info
+org.eclipse.jdt.core.compiler.problem.potentialNullReference=info
+org.eclipse.jdt.core.compiler.problem.potentiallyUnclosedCloseable=ignore
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.redundantNullAnnotation=warning
+org.eclipse.jdt.core.compiler.problem.redundantNullCheck=info
+org.eclipse.jdt.core.compiler.problem.redundantSpecificationOfTypeArguments=info
+org.eclipse.jdt.core.compiler.problem.redundantSuperinterface=info
+org.eclipse.jdt.core.compiler.problem.reportMethodCanBePotentiallyStatic=ignore
+org.eclipse.jdt.core.compiler.problem.reportMethodCanBeStatic=ignore
 org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
+org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
+org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
+org.eclipse.jdt.core.compiler.problem.suppressOptionalErrors=disabled
+org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
+org.eclipse.jdt.core.compiler.problem.suppressWarningsNotFullyAnalysed=info
+org.eclipse.jdt.core.compiler.problem.syntacticNullAnalysisForFields=disabled
+org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
+org.eclipse.jdt.core.compiler.problem.terminalDeprecation=warning
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
+org.eclipse.jdt.core.compiler.problem.unavoidableGenericTypeProblems=disabled
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
+org.eclipse.jdt.core.compiler.problem.unclosedCloseable=warning
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=info
+org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.unlikelyCollectionMethodArgumentType=warning
+org.eclipse.jdt.core.compiler.problem.unlikelyCollectionMethodArgumentTypeStrict=disabled
+org.eclipse.jdt.core.compiler.problem.unlikelyEqualsArgumentType=info
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=info
+org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
+org.eclipse.jdt.core.compiler.problem.unstableAutoModuleName=warning
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=info
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable=enabled
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=enabled
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.unusedExceptionParameter=ignore
+org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedObjectAllocation=ignore
+org.eclipse.jdt.core.compiler.problem.unusedParameter=info
+org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference=enabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
+org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=info
+org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning
+org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
 org.eclipse.jdt.core.compiler.release=disabled
 org.eclipse.jdt.core.compiler.source=1.8
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
index bcd3096..e2cb8b4 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLModifiers.java
@@ -36,6 +36,8 @@ public class CLModifiers {
 	 *               The state of the colon mod.
 	 * @param dollar
 	 *               The state of the dollar mod.
+	 * @param star
+	 *               The state of the star mod.
 	 */
 	public CLModifiers(boolean at, boolean colon, boolean dollar, boolean star) {
 		atMod = at;
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
index 1ac025b..aef8fbe 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLParameters.java
@@ -347,7 +347,7 @@ public class CLParameters {
 	/**
 	 * Get a boolean-valued parameter.
 	 *
-	 * @param params
+	 * @param parms
 	 *                  The format parameters to use.
 	 *
 	 * @param key
@@ -365,9 +365,9 @@ public class CLParameters {
 	 * @return The boolean value for that parameter, or the default value if that
 	 *         parameter didn't exist.
 	 */
-	public boolean getBoolean(Tape<Object> params, String key, String paramName,
+	public boolean getBoolean(Tape<Object> parms, String key, String paramName,
 			String directive, boolean def) {
-		String bol = resolveKey(key).getValue(params);
+		String bol = resolveKey(key).getValue(parms);
 
 		if (!bol.equals("")) {
 			if (bol.matches(RX_TRUE))
@@ -386,7 +386,7 @@ public class CLParameters {
 	/**
 	 * Get the string value for a parameter.
 	 *
-	 * @param params
+	 * @param parms
 	 *                  The format parameters we're using.
 	 *
 	 * @param key
@@ -404,9 +404,9 @@ public class CLParameters {
 	 * @return The string value of the parameter, or the default value if there is
 	 *         no parameter by that name.
 	 */
-	public String getString(Tape<Object> params, String key, String paramName,
+	public String getString(Tape<Object> parms, String key, String paramName,
 			String directive, String def) {
-		String vl = resolveKey(key).getValue(params);
+		String vl = resolveKey(key).getValue(parms);
 
 		// @NOTE 9/19/17
 		//
@@ -421,7 +421,7 @@ public class CLParameters {
 	/**
 	 * Get the character value of a parameter.
 	 *
-	 * @param params
+	 * @param parms
 	 *                  The format parameters to use.
 	 *
 	 * @param key
@@ -432,13 +432,14 @@ public class CLParameters {
 	 *
 	 * @param directive
 	 *                  The directive the parameter is for.
+	 * @param def The default value of the char.
 	 *
 	 * @return The character value of the parameter, or the default value if the
 	 *         parameter isn't specified.
 	 */
-	public char getChar(Tape<Object> params, String key, String paramName,
+	public char getChar(Tape<Object> parms, String key, String paramName,
 			String directive, char def) {
-		String param = resolveKey(key).getValue(params);
+		String param = resolveKey(key).getValue(parms);
 
 		if (!param.equals("")) {
 			if (param.length() == 1) {
@@ -461,7 +462,7 @@ public class CLParameters {
 	/**
 	 * Get the integer value for a parameter.
 	 *
-	 * @param params
+	 * @param parms
 	 *                  The format parameters we are using.
 	 *
 	 * @param key
@@ -479,9 +480,9 @@ public class CLParameters {
 	 * @return The integer value of the parameter, or the default value if there is
 	 *         no parameter by that name.
 	 */
-	public int getInt(Tape<Object> params, String key, String paramName, String directive,
+	public int getInt(Tape<Object> parms, String key, String paramName, String directive,
 			int def) {
-		String param = resolveKey(key).getValue(params);
+		String param = resolveKey(key).getValue(parms);
 
 		if (!param.equals("")) {
 			try {
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
index b3d7762..fd303d5 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLPattern.java
@@ -51,6 +51,7 @@ public class CLPattern {
 	 *
 	 * @param inp
 	 *            The string to parse directives from.
+	 * @return A matcher for format directives in the string.          
 	 */
 	public static Matcher getDirectiveMatcher(String inp) {
 		return pFormatDirective.matcher(inp);
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
index c26a936..491d629 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/ConditionalDirective.java
@@ -182,6 +182,10 @@ class ConditionalEdict implements Edict {
 				}
 			}
 				break;
+			default:
+				// IMPROVE Should probably handle this
+				// -- Ben Culkin, 4/14/2020
+				break;
 			}
 		} catch (DirectiveEscape dex) {
 			// Conditionals are transparent to iteration-escapes
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
index 6cb0192..49ed4b1 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/Edict.java
@@ -15,6 +15,7 @@ public interface Edict {
 	 *
 	 * @param formCTX
 	 *                The state needed for this invocation.
+	 * @throws IOException Thrown if an I/O error happens.
 	 */
 	public void format(FormatContext formCTX) throws IOException;
 }
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
index 9208b0e..c7d4ab6 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/NumberDirective.java
@@ -19,9 +19,11 @@ public class NumberDirective extends GeneralNumberDirective {
 	 * Create a new radix based number directive.
 	 *
 	 * @param argidx
-	 *               The argument offset to use.
+	 *                  The argument offset to use.
 	 * @param radix
-	 *               The radix of the number to use.
+	 *                  The radix of the number to use.
+	 * @param directive
+	 *                  The character that marks this directive.
 	 */
 	public NumberDirective(int argidx, int radix, char directive) {
 		this.argidx = argidx;
diff --git a/clformat/src/test/java/bjc/utils/test/ioutils/CLFormatterTest.java b/clformat/src/test/java/bjc/utils/test/ioutils/CLFormatterTest.java
index 96723f4..8cd3e61 100644
--- a/clformat/src/test/java/bjc/utils/test/ioutils/CLFormatterTest.java
+++ b/clformat/src/test/java/bjc/utils/test/ioutils/CLFormatterTest.java
@@ -143,8 +143,8 @@ public class CLFormatterTest {
 		assertEquals("3 dogs are here", format("~D dog~:[s are~; is~] here", 3, 3 == 1));
 	}
 
-	private void assertFormat(String res, String fmt, Object... params) {
-		assertEquals(res, format(fmt, params));
+	private void assertFormat(String res, String fomt, Object... params) {
+		assertEquals(res, format(fomt, params));
 	}
 
 	private String format(String str, Object... params) {