From a7a87f682a039d4761112f1dedb9351f3d7a2bbf Mon Sep 17 00:00:00 2001 From: Ben Culkin Date: Tue, 6 Oct 2020 19:26:52 -0400 Subject: Rename exceptions to not use Exception This renames several of the stock exceptions to remove 'Exception' from their name. This is something that I don't recall where I picked it up from, but the idea is that the fact that it is an exception is generally syntactically obvious. Therefore, you can instead give your exceptions names which directly state what it wrong, as well as strongly implying what you can do to fix it. For instance, if you get a DirectionInvalid, it is apparent what the issue is (it is less apparent why it is invalid, but that is another issue, and a discussion for another time) --- .../java/bjc/utils/exceptions/BadPragmaFormat.java | 28 ++++++++++++++++++++++ .../bjc/utils/exceptions/DirectionInvalid.java | 26 ++++++++++++++++++++ .../utils/exceptions/FileNotChosenException.java | 28 ---------------------- .../exceptions/InvalidDirectionException.java | 26 -------------------- .../java/bjc/utils/exceptions/NoFileChosen.java | 28 ++++++++++++++++++++++ .../utils/exceptions/PragmaFormatException.java | 28 ---------------------- .../java/bjc/utils/exceptions/UnknownPragma.java | 24 +++++++++++++++++++ .../utils/exceptions/UnknownPragmaException.java | 24 ------------------- 8 files changed, 106 insertions(+), 106 deletions(-) create mode 100644 base/src/main/java/bjc/utils/exceptions/BadPragmaFormat.java create mode 100644 base/src/main/java/bjc/utils/exceptions/DirectionInvalid.java delete mode 100644 base/src/main/java/bjc/utils/exceptions/FileNotChosenException.java delete mode 100644 base/src/main/java/bjc/utils/exceptions/InvalidDirectionException.java create mode 100644 base/src/main/java/bjc/utils/exceptions/NoFileChosen.java delete mode 100644 base/src/main/java/bjc/utils/exceptions/PragmaFormatException.java create mode 100644 base/src/main/java/bjc/utils/exceptions/UnknownPragma.java delete mode 100644 base/src/main/java/bjc/utils/exceptions/UnknownPragmaException.java (limited to 'base/src/main/java/bjc/utils/exceptions') diff --git a/base/src/main/java/bjc/utils/exceptions/BadPragmaFormat.java b/base/src/main/java/bjc/utils/exceptions/BadPragmaFormat.java new file mode 100644 index 0000000..48b5be0 --- /dev/null +++ b/base/src/main/java/bjc/utils/exceptions/BadPragmaFormat.java @@ -0,0 +1,28 @@ +package bjc.utils.exceptions; + +import java.util.InputMismatchException; + +/** + * The exception to throw whenever a pragma is used with invalid syntax. + * + * @author ben + */ +public class BadPragmaFormat extends InputMismatchException { + /* Version ID for serialization. */ + private static final long serialVersionUID = 1288536477368021069L; + + /** Create a new exception */ + public BadPragmaFormat() { + super(); + } + + /** + * Create a new exception with the given message. + * + * @param message + * The message to explain why the exception was thrown. + */ + public BadPragmaFormat(final String message) { + super(message); + } +} diff --git a/base/src/main/java/bjc/utils/exceptions/DirectionInvalid.java b/base/src/main/java/bjc/utils/exceptions/DirectionInvalid.java new file mode 100644 index 0000000..25f6cf8 --- /dev/null +++ b/base/src/main/java/bjc/utils/exceptions/DirectionInvalid.java @@ -0,0 +1,26 @@ +package bjc.utils.exceptions; + +/** + * Represents the condition where a direction has been used in a improper manner + * + * @author ben + * + */ +public class DirectionInvalid extends IllegalArgumentException { + + /** + * Version for serialization + */ + private static final long serialVersionUID = 6852151917518831932L; + + /** + * Create a new {@link DirectionInvalid} with the given cause + * + * @param cause + * The situation that resulting in this exit being thrown + */ + public DirectionInvalid(String cause) { + super(cause); + } + +} diff --git a/base/src/main/java/bjc/utils/exceptions/FileNotChosenException.java b/base/src/main/java/bjc/utils/exceptions/FileNotChosenException.java deleted file mode 100644 index dcd47de..0000000 --- a/base/src/main/java/bjc/utils/exceptions/FileNotChosenException.java +++ /dev/null @@ -1,28 +0,0 @@ -package bjc.utils.exceptions; - -import java.io.IOException; - -/** - * Represents the user failing to choose a file. - * - * @author ben - */ -public class FileNotChosenException extends IOException { - /* Version ID for serialization. */ - private static final long serialVersionUID = -8753348705210831096L; - - /** Create a new exception. */ - public FileNotChosenException() { - super(); - } - - /** - * Create a new exception with the given cause. - * - * @param cause - * The cause of why the exception was thrown. - */ - public FileNotChosenException(final String cause) { - super(cause); - } -} diff --git a/base/src/main/java/bjc/utils/exceptions/InvalidDirectionException.java b/base/src/main/java/bjc/utils/exceptions/InvalidDirectionException.java deleted file mode 100644 index d20b2d1..0000000 --- a/base/src/main/java/bjc/utils/exceptions/InvalidDirectionException.java +++ /dev/null @@ -1,26 +0,0 @@ -package bjc.utils.exceptions; - -/** - * Represents the condition where a direction has been used in a improper manner - * - * @author ben - * - */ -public class InvalidDirectionException extends IllegalArgumentException { - - /** - * Version for serialization - */ - private static final long serialVersionUID = 6852151917518831932L; - - /** - * Create a new {@link InvalidDirectionException} with the given cause - * - * @param cause - * The situation that resulting in this exit being thrown - */ - public InvalidDirectionException(String cause) { - super(cause); - } - -} diff --git a/base/src/main/java/bjc/utils/exceptions/NoFileChosen.java b/base/src/main/java/bjc/utils/exceptions/NoFileChosen.java new file mode 100644 index 0000000..c627dab --- /dev/null +++ b/base/src/main/java/bjc/utils/exceptions/NoFileChosen.java @@ -0,0 +1,28 @@ +package bjc.utils.exceptions; + +import java.io.IOException; + +/** + * Represents the user failing to choose a file. + * + * @author ben + */ +public class NoFileChosen extends IOException { + /* Version ID for serialization. */ + private static final long serialVersionUID = -8753348705210831096L; + + /** Create a new exception. */ + public NoFileChosen() { + super(); + } + + /** + * Create a new exception with the given cause. + * + * @param cause + * The cause of why the exception was thrown. + */ + public NoFileChosen(final String cause) { + super(cause); + } +} diff --git a/base/src/main/java/bjc/utils/exceptions/PragmaFormatException.java b/base/src/main/java/bjc/utils/exceptions/PragmaFormatException.java deleted file mode 100644 index 684c63d..0000000 --- a/base/src/main/java/bjc/utils/exceptions/PragmaFormatException.java +++ /dev/null @@ -1,28 +0,0 @@ -package bjc.utils.exceptions; - -import java.util.InputMismatchException; - -/** - * The exception to throw whenever a pragma is used with invalid syntax. - * - * @author ben - */ -public class PragmaFormatException extends InputMismatchException { - /* Version ID for serialization. */ - private static final long serialVersionUID = 1288536477368021069L; - - /** Create a new exception */ - public PragmaFormatException() { - super(); - } - - /** - * Create a new exception with the given message. - * - * @param message - * The message to explain why the exception was thrown. - */ - public PragmaFormatException(final String message) { - super(message); - } -} diff --git a/base/src/main/java/bjc/utils/exceptions/UnknownPragma.java b/base/src/main/java/bjc/utils/exceptions/UnknownPragma.java new file mode 100644 index 0000000..0f2f7c4 --- /dev/null +++ b/base/src/main/java/bjc/utils/exceptions/UnknownPragma.java @@ -0,0 +1,24 @@ +package bjc.utils.exceptions; + +import java.util.InputMismatchException; + +/** + * Represents a error from encountering a unknown pragma. + * + * @author ben + */ +public class UnknownPragma extends InputMismatchException { + /* Version ID for serialization. */ + private static final long serialVersionUID = -4277573484926638662L; + + /** + * Create a new exception with the given cause. + * + * @param cause + * The cause for throwing this exception. + */ + public UnknownPragma(final String cause) { + super(cause); + } + +} diff --git a/base/src/main/java/bjc/utils/exceptions/UnknownPragmaException.java b/base/src/main/java/bjc/utils/exceptions/UnknownPragmaException.java deleted file mode 100644 index dec89a3..0000000 --- a/base/src/main/java/bjc/utils/exceptions/UnknownPragmaException.java +++ /dev/null @@ -1,24 +0,0 @@ -package bjc.utils.exceptions; - -import java.util.InputMismatchException; - -/** - * Represents a error from encountering a unknown pragma. - * - * @author ben - */ -public class UnknownPragmaException extends InputMismatchException { - /* Version ID for serialization. */ - private static final long serialVersionUID = -4277573484926638662L; - - /** - * Create a new exception with the given cause. - * - * @param cause - * The cause for throwing this exception. - */ - public UnknownPragmaException(final String cause) { - super(cause); - } - -} -- cgit v1.2.3