Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 3.19 KB

README.md

File metadata and controls

111 lines (81 loc) · 3.19 KB
Raw

Rhino-error

History

This repo has been migrated from coteafs-error. It now supports latest JDK 14 (Preview).

What is it all about?

This framework helps in wrapping Exceptions and re-throwing custom Error wrapped on top of AssertionError class. It can be used to wrap Excpetions and further catogorise the Error into Reasons, category and severity.

Why created this project?

This project has been created to solve the problem where we encounter exceptions from the library which we are using which are not descriptive enough to understand by just looking at it in the logs, however, we know while debugging what the exception is all about.

Now we can wrap those exceptions in Rhino-error and re-throw it with some descriptive message and descriptive Error name . This will help reduce the pain of debugging and help understand what went wrong by just looking in the logs.

Examples

fail method

Use ErrorUtil.fail method to wrap and rethrow the Exception. See example below.

import static com.github.wizonqalabs.rhino.error.util.ErrorUtil.fail;

. . .

// Throw new Custom Error with message.
fail (NotImplementedError.class, "Some Error message!");

. . .

// Throw new Custom Error with message and categorize it.
try {
  . . some code . .
}
catch (FileNotFoundException e) {
  fail (RhinoError.class, "Test Error!", Reason.R2, Category.C1, Severity.CRITICAL);
}

. . .

// Throw wrapped Exception into a Custom Error with message.
try {
  . . some code . .
}
catch (FileNotFoundException e) {
  fail (OperationNotSupportedError.class, "Some Error message!", e);
}

. . .

// Categorise the wrapped Error.
try {
  . . some code . .
}
catch (FileNotFoundException e) {
  fail (RhinoError.class, "Test Error!", e, Reason.R2, Category.C1, Severity.CRITICAL);
}

. . .

handleError method

This method helps in collecting and filtering stacktrace for a particular package which can be helpful in logging of errors.

. . .
try {
  [code block]
} catch (final Exception e) {
  // Filter exception to show only exception occurred in only the given package.
  handleError("com.github.wizonqalabs", e).forEach(System.err::println);

// OR

  // This will show complete exception stack occurred.
  handleError(e).forEach(System.err::println);
}

Will output formatted exception with filtered stacktrace by package name like this,

Error occurred: (com.github.wizonqalabs.rhino.error.RhinoError)
Message: Test Error!
  at com.github.wizonqalabs.rhino.error.util.ErrorUtil: fail (147)
  at com.github.wizonqalabs.rhino.error.util.ErrorUtil: fail (95)
  at com.github.wizonqalabs.rhino.error.util.ErrorUtilTest: testRhinoErrorWithFiveArg (48)
Caused by: (class java.io.FileNotFoundException)
Message: null
  at com.github.wizonqalabs.rhino.error.util.ErrorUtil: fail (147)
  at com.github.wizonqalabs.rhino.error.util.ErrorUtil: fail (95)
  at com.github.wizonqalabs.rhino.error.util.ErrorUtilTest: testRhinoErrorWithFiveArg (48)

Usage

In your pom.xml, add following block to use this POM,

<dependency>
  <groupId>com.github.wizonqalabs.rhino</groupId>
  <artifactId>rhino-error</artifactId>
  <version>1.0.0</version>
</dependency>