General cleanliness pass

5 files changed, 56 insertions, 5 deletions

diff --git a/src/main/java/bjc/everge/ReplParseException.java b/src/main/java/bjc/everge/BadReplParse.java
index 9473b71..e3858af 100644
--- a/src/main/java/bjc/everge/ReplParseException.java
+++ b/src/main/java/bjc/everge/BadReplParse.java
@@ -2,19 +2,40 @@ package bjc.everge;
 
 import java.util.ArrayList;
 import java.util.List;
-
-public class ReplParseException extends RuntimeException {
+/**
+ * Exception thrown when ReplPair parsing fails
+ * @author bjculkin
+ *
+ */
+public class BadReplParse extends RuntimeException {
 	/**
 	 * Serialization ID.
 	 */
 	private static final long serialVersionUID = 4752304282380556849L;
+	/**
+	 * The errors that were encountered during parsing.
+	 */
 	public List<ReplError> errs;
 
-	public ReplParseException(String msg) {
+	/**
+	 * Create a new exception for ReplPair parsing failing.
+	 * 
+	 * @param msg 
+	 * 	The message for the exception.
+	 */
+	public BadReplParse(String msg) {
 		this(msg, new ArrayList<>());
 	}
 
-	public ReplParseException(String msg, List<ReplError> errs) {
+	/**
+	 * Create a new exception for ReplPair parsing failing.
+	 * 
+	 * @param msg
+	 * 	The message for the exception.
+	 * @param errs
+	 * 	The list of errors encountered while parsing.
+	 */
+	public BadReplParse(String msg, List<ReplError> errs) {
 		super(msg);
 
 		this.errs = errs;
@@ -30,6 +51,11 @@ public class ReplParseException extends RuntimeException {
 				errString, getMessage(), errs);
 	}
 
+	/**
+	 * Convert the exception to a printable format.
+	 * 
+	 * @return The exception as a printable format.
+	 */
 	public String toPrintString() {
 		StringBuilder errString = new StringBuilder("[ERROR] ");
 
diff --git a/src/main/java/bjc/everge/IntHolder.java b/src/main/java/bjc/everge/IntHolder.java
index e137d61..b72e0e7 100644
--- a/src/main/java/bjc/everge/IntHolder.java
+++ b/src/main/java/bjc/everge/IntHolder.java
@@ -60,6 +60,12 @@ public class IntHolder {
 		return val;
 	}
 
+	/**
+	 * Set the value.
+	 * 
+	 * @param i
+	 * 	The value to set it to.
+	 */
 	public void set(int i) {
 		val = i;
 	}
diff --git a/src/main/java/bjc/everge/ReplError.java b/src/main/java/bjc/everge/ReplError.java
index c86ec0e..2e1334c 100644
--- a/src/main/java/bjc/everge/ReplError.java
+++ b/src/main/java/bjc/everge/ReplError.java
@@ -70,10 +70,23 @@ public class ReplError {
 		return String.format("line %d, pair %d:%s\n\t%s", line, numPairs, msg, errString);
 	}
 
+	/**
+	 * Convert the error to a printable string.
+	 * 
+	 * @return The error as a printable string.
+	 */
 	public String toPrintString() {
 		return toPrintString("");
 	}
 
+	/**
+	 * Convert the error to a printable string, with a custom header.
+	 * 
+	 * @param hdr
+	 * 	The text to include in the header.
+	 * 
+	 * @return The error as a printable string.
+	 */
 	public String toPrintString(String hdr) {
 		String errString;
 		if      (txt == null)    errString = "No associated line";
diff --git a/src/main/java/bjc/everge/ReplOpts.java b/src/main/java/bjc/everge/ReplOpts.java
index 85765d5..6086310 100644
--- a/src/main/java/bjc/everge/ReplOpts.java
+++ b/src/main/java/bjc/everge/ReplOpts.java
@@ -43,7 +43,13 @@ public class ReplOpts {
 	 */
 	public boolean isPerf = false;
 
+	/**
+	 * The stream to print normal output on.
+	 */
 	public PrintStream outStream = System.out;
+	/**
+	 * The stream to print error output on.
+	 */
 	public PrintStream errStream = System.err;
 	@Override
 	public int hashCode() {
diff --git a/src/main/java/bjc/everge/ReplPair.java b/src/main/java/bjc/everge/ReplPair.java
index da6f6eb..11ca3ef 100644
--- a/src/main/java/bjc/everge/ReplPair.java
+++ b/src/main/java/bjc/everge/ReplPair.java
@@ -145,7 +145,7 @@ public class ReplPair implements Comparable<ReplPair>, UnaryOperator<String> {
 		List<ReplPair> rplPar = readList(detals, scn, errList);
 
 		if (errList.size() != 0) {
-			throw new ReplParseException("", errList);
+			throw new BadReplParse("", errList);
 		}
 
 		return rplPar;