How To Practise Custom Exception Inwards Coffee - Tutorial Example

Sometimes nosotros ask to hit custom Exception inwards Java, i.e. Exceptions which are non defined inwards JDK or whatsoever tertiary political party library your application is using. Though it’s widely recommended on several Exception best practices article, fifty-fifty Joshua Bloch has recommended inwards Effective Java to prefer criterion exception over custom exception, sometimes you lot truly ask it. There are for certain guidelines to assist to discovery whether you lot truly ask a custom exception or not. You should write your ain exception classes if you lot answer yeah to whatsoever of the next questions; otherwise, you lot tin in all probability role mortal else's.

•     Do you lot ask an exception type that isn't represented past times those inwards the Java platform?
•     Would it assist users if they could differentiate your exceptions from those thrown past times classes written past times other vendors?
•     Does your code throw to a greater extent than than ane related exception?
•     If you lot role mortal else's exceptions, volition users receive got access to those exceptions? The similar query is, should your packet hold upward independent together with self-contained?

Custom Exception or Custom Message amongst Standard Exception?

For event if you lot declare an Exception that doesn't render whatsoever useful information other than a custom cite together with then it in all probability uses generic Exception shape amongst a custom message every bit shown inwards below example:

public class DuplicateIDException extends Exception {}

This custom exception doesn't render whatsoever extra information e.g. option ids, together with that's why tin hold upward easily replaced past times a custom message together with criterion Exception class, every bit shown below:

throw new Exception("ID already taken");

Even better, if you lot mean value the customer code is non going to bring whatsoever activity other than logging if the id is already taken, throw an unchecked exception:

throw new RuntimeException("ID already taken");

Checked or Unchecked?

Once you lot hit the determination to hit custom Exception, the adjacent affair is to hit upward one's hear on checked vs unchecked exception. As I said before, past times default hit your exception unchecked together with you lot volition discovery it whether it should hold upward checked spell writing customer code. General guideline is to hit an exception unchecked if the customer code is non going to bring whatsoever activity other than logging.

How to hit Custom Exception inwards Java - The Code

Here is our consummate code event of creating custom or user defined Exception inwards Java.  In our example, nosotros receive got created NoSuchProductException, which is thrown past times methods returning products. This is an unchecked Exception every bit nosotros made it inherit from RuntimeException. It inherit getMessage() method from Throwable together with likewise has a method getProductId() which returns production id for which this exception has caused. Don't hit an Exception shape every bit nested class fifty-fifty if it's used alone past times ane class, ever declare Exceptions inwards their ain class.

import java.util.HashMap; import java.util.Map;  /**  * Java Program to hit custom exception together with examples to demo how to role  * custom exception inwards Java.  *  * @author Javin Paul  */ public class CustomExceptionDemo {      private static final Map&lt;Integer, String&gt; products = new HashMap<>();      static {         products.put(100, "Coke");         products.put(101, "KitKat");         products.put(102, "Bisuits");         products.put(103, "Toast");     }      public static void main(String args[]) {         CustomExceptionDemo t = new CustomExceptionDemo();         t.getProduct(1000);     }      public String getProduct(int id) {         if (products.get(id) == null) {             throw new NoSuchProductException("No such production exists", id);         }         return products.get(id);     } }  class NoSuchProductException extends RuntimeException {      private int productId;      public NoSuchProductException() {         super();     }      public NoSuchProductException(String message, int productId) {         super(message);         this.productId = productId;     }      public NoSuchProductException(String message, int productId, Throwable cause) {         super(message, cause);         this.productId = productId;     }      @Override     public String toString() {         return super.toString();     }      @Override     public String getMessage() {         return super.getMessage() + " for productId :" + productId;     }      public int getProductId() {         return productId;     } }  Output: Exception inwards thread "main" NoSuchProductException: No such production exists for productId :1000     at CustomExceptionDemo.getProduct(CustomExceptionDemo.java:26)     at CustomExceptionDemo.main(CustomExceptionDemo.java:21)

Things to recollect spell creating Custom Exception inwards Java

Though creating a custom, exception is every bit slowly every bit subclassing java.lang.Exception class, in that location are few best practices you lot tin follow to hit most of it. There is thus much criticism of checked exception due to boilerplate require to grip it, you lot volition hardly hit your custom exception every bit checked.

1) Don’t' role Exception to command application behavior. Exception treatment is real expensive every bit it requires native calls to re-create stack trace, each fourth dimension exception is created.

2) While creating a custom exception, prefer to hit an unchecked, Runtime exception than a checked exception, peculiarly if you lot know that customer is non going to bring whatsoever reactive activity other than logging.

3) If your custom exception is created past times passing around other exception, together with then ever incorporate master Exception every bit a source; role constructor which takes Exception rather than alone message String.

4) Apart from providing default no declaration constructor on your custom Exception class, regard providing at to the lowest degree ii to a greater extent than constructors, ane which should bring a failure message together with other which tin bring around other Throwable every bit the cause.

5) If possible, avoid creating custom Exception together with re-use existing, criterion Exception classes from JDK itself. Most of the fourth dimension you lot volition realize that all you lot ask is a shape of IllegalArgumentException or ParseException or something similar.

6) While defining custom Exception, ane of the most mutual error programmer hit is to mean value that constructor is inherited from java.lang.Exception class, for example, they mean value that their Exception shape volition automatically inherit default no declaration constructor together with the ane which takes a String message. This is non true. The constructor is non inherited inwards Java, non fifty-fifty default constructor. It's truly added past times the compiler rather than inherited from raise class. That's why I receive got declared ii constructors, ane amongst String parameter together with other every bit Throwable parameter:

public NoSuchProductException(String message, int productId) {         super(message);         this.productId = productId;     }      public NoSuchProductException(String message, int productId, Throwable cause) {         super(message, cause);         this.productId = productId;     }
 

This is truly the criterion agency of creating custom Exception inwards Java. In guild to salve time, you lot tin fifty-fifty hit a template of inwards a higher house shape inwards Eclipse IDE.

7) For readable code, it's practiced practise to append the string Exception to the names of all classes that inherits (directly or indirectly) from the Exception shape e.g. instead of naming your shape IncorrectPassword, cite it IncorrectPasswordException.


That's all virtually How to hit custom Exception classes inwards Java. As I said, kickoff essay out to avoid the temptation of creating a hit novel Exception class, mean value if you lot tin reuse existing ones. If you lot absolutely need, together with then hit for certain to follow best practices. At the bare minimum, hit an endeavour to hit unchecked exception rather than a checked one.

Further Learning
Complete Java Masterclass
Java Fundamentals: The Java Language
Java In-Depth: Become a Complete Java Engineer!