Exception classes must be named appropriately JAVA-W1000
Anti-pattern
Minor
6 months ago
—
2 years old
ParsingResultComparisonFailure is an Exception but is not named appropriately
29 *
30 * @since 1.16
31 */
32public class ParsingResultComparisonFailure extends AssertionError {3334 private final String message;35 private final String fExpected;36 private final String fActual;3738 public ParsingResultComparisonFailure(String expected, String actual) {39 this(expected + '\n' + actual, expected, actual);40 }4142 public ParsingResultComparisonFailure(String message, String expected, String actual) {43 super(message);44 this.message = message;45 this.fExpected = expected;46 this.fActual = actual;47 }4849 /**50 * Returns the actual string value51 *52 * @return the actual string value53 */54 public String getActual() {55 return fActual;56 }5758 /**59 * Returns the expected string value60 *61 * @return the expected string value62 */63 public String getExpected() {64 return fExpected;65 }6667 @Override68 public String getMessage() {69 return message;70 }7172}
Description
This class is an exception, but its name does not end in Exception. This could be confusing to consumers of your API.
Bad Practice
class BadName extends Exception {
// ...
}
Recommended
class ActuallyAnException extends Exception {
// ...
}