From e60131eb4ead92f3ab1caf29d9c89d5d507092d5 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Mon, 9 Sep 2019 19:27:05 -0400 Subject: General cleanliness pass --- src/main/java/bjc/everge/BadReplParse.java | 88 ++++++++++++++++++++++++ src/main/java/bjc/everge/IntHolder.java | 6 ++ src/main/java/bjc/everge/ReplError.java | 13 ++++ src/main/java/bjc/everge/ReplOpts.java | 6 ++ src/main/java/bjc/everge/ReplPair.java | 2 +- src/main/java/bjc/everge/ReplParseException.java | 62 ----------------- 6 files changed, 114 insertions(+), 63 deletions(-) create mode 100644 src/main/java/bjc/everge/BadReplParse.java delete mode 100644 src/main/java/bjc/everge/ReplParseException.java (limited to 'src/main') diff --git a/src/main/java/bjc/everge/BadReplParse.java b/src/main/java/bjc/everge/BadReplParse.java new file mode 100644 index 0000000..e3858af --- /dev/null +++ b/src/main/java/bjc/everge/BadReplParse.java @@ -0,0 +1,88 @@ +package bjc.everge; + +import java.util.ArrayList; +import java.util.List; +/** + * 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 errs; + + /** + * Create a new exception for ReplPair parsing failing. + * + * @param msg + * The message for the exception. + */ + public BadReplParse(String msg) { + this(msg, new ArrayList<>()); + } + + /** + * 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 errs) { + super(msg); + + this.errs = errs; + } + + @Override + public String toString() { + String errString; + if (errs.size() == 0) errString = "An error"; + else errString = "Errors"; + + return String.format("%s occured parsing replacement pairs: %s\n%s", + 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] "); + + if (errs.size() == 0) { + errString.append("No specific errors"); + } else if (errs.size() == 1) { + errString.append("An error"); + } else { + errString.append(errs.size()); + errString.append(" errors"); + } + + errString.append(" occured parsing replacement pairs:"); + if (!getMessage().equals("")) { + errString.append(" "); + errString.append(getMessage()); + } + + if (errs.size() > 0) { + errString.append("\n\t"); + + for (ReplError err : errs) { + errString.append(err.toPrintString("\t")); + errString.append("\n\t"); + } + } + + return errString.toString().trim(); + } +} 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, UnaryOperator { List rplPar = readList(detals, scn, errList); if (errList.size() != 0) { - throw new ReplParseException("", errList); + throw new BadReplParse("", errList); } return rplPar; diff --git a/src/main/java/bjc/everge/ReplParseException.java b/src/main/java/bjc/everge/ReplParseException.java deleted file mode 100644 index 9473b71..0000000 --- a/src/main/java/bjc/everge/ReplParseException.java +++ /dev/null @@ -1,62 +0,0 @@ -package bjc.everge; - -import java.util.ArrayList; -import java.util.List; - -public class ReplParseException extends RuntimeException { - /** - * Serialization ID. - */ - private static final long serialVersionUID = 4752304282380556849L; - public List errs; - - public ReplParseException(String msg) { - this(msg, new ArrayList<>()); - } - - public ReplParseException(String msg, List errs) { - super(msg); - - this.errs = errs; - } - - @Override - public String toString() { - String errString; - if (errs.size() == 0) errString = "An error"; - else errString = "Errors"; - - return String.format("%s occured parsing replacement pairs: %s\n%s", - errString, getMessage(), errs); - } - - public String toPrintString() { - StringBuilder errString = new StringBuilder("[ERROR] "); - - if (errs.size() == 0) { - errString.append("No specific errors"); - } else if (errs.size() == 1) { - errString.append("An error"); - } else { - errString.append(errs.size()); - errString.append(" errors"); - } - - errString.append(" occured parsing replacement pairs:"); - if (!getMessage().equals("")) { - errString.append(" "); - errString.append(getMessage()); - } - - if (errs.size() > 0) { - errString.append("\n\t"); - - for (ReplError err : errs) { - errString.append(err.toPrintString("\t")); - errString.append("\n\t"); - } - } - - return errString.toString().trim(); - } -} -- cgit v1.2.3