Welcome!

Java IoT Authors: Jason Bloomberg, Liz McMillan, Elizabeth White, Pat Romanski, Stackify Blog

Related Topics: Java IoT

Java IoT: Article

Java Exceptions

Lesson 4

Java Exceptions Lesson 4

Let's say a Java class reads a file with the customer's data. What's going to happen if someone deletes this file?

Will the program crash with that scary multi-line error message, or will it stay alive displaying a user friendly message like this one: "Dear friend, for some reason I could not read the file customer.txt. Please make sure that the file exists"? In many programming languages, error processing depends on the skills of a programmer.

Java forces software developers to include error processing code, otherwise the programs will not even compile.

Error processing in the Java is called exception handling.

You have to place code that may produce errors in a so-called try/catch block:

try{
  fileCustomer.read();     
  process(fileCustomer);
}
catch (IOException e){
  System.out.println("Dear friend, I could not read the file customer.txt...");  
}

In case of an error, the method read() throws an exception. In this example the catch clause receives the instance of the class IOException that contains information about input/output errors that have occured. If the catch block exists for this type of error, the exception will be caught and the statements located in a catch block will be executed. The program will not terminate and this exception is considered to be taken care of.

The print statement from the code above will be executed only in case of the file read error. Please note that method process() will not even be called if the read fails.

Reading the Stack Trace

If an unexpected exception occurs that's not handled in the code, the program may print multiple error messages on the screen. Theses messages will help you to trace all method calls that lead to this error. This printout is called a stack trace. If a program performs a number of nested method calls to reach the problematic line, a stack trace can help you trace the workflow of the program, and localize the error.

Let's write a program that will intentionally divide by zero:

class TestStackTrace{    
  TestStackTrace()
  {
    divideByZero();
  }

  int divideByZero()
  {
    return 25/0;
  }

  static void main(String[]args)
  {
    new TestStackTrace();
  }
}

Below is an output of the program - it traced what happened in the program stack before the error had occurred. Start reading it from the last line going up. It reads that the program was executing methods main(), init() (constructor), and divideByZero(). The line numbers 14, 4 and 9 (see below) indicate where in the program these methods were called. After that, the ArithmeticException had been thrown - the line number nine tried to divide by zero.

c:\temp>java TestStackTrace
  Exception in thread "main"  
  java.lang.ArithmeticException: / by zero
     at TestStackTrace.divideByZero(TestStackTrace.java:9)
     at TestStackTrace.(TestStackTrace.java:4)
     at TestStackTrace.main(TestStackTrace.java:14)

Exception Hierarchy

All exceptions in Java are classes implicitely derived from the class Throwable which has immediate subclasses

Error and Exception.

Subclasses of the class Exception are called listed exceptions and have to be handled in your code.

Subclasses of the class Error are fatal JVM errors and your program can't fix them. Programmers also can define their own exceptions.

How you are supposed to know in advance if some Java method may throw a particular exception and the try/catch block should be used? Don't worry - if a method throws an exception and you did not put this method call in a try/catch block, the Java compiler will print an error message similar to this one:

"Tax.java": unreported exception: java.io.IOException; must be caught or declared to be thrown at line 57

Try/Catch Block

There are five Java keywords that could be used for exceptions handling: try, catch, finally, throw, and throws.

By placing a code in a try/catch block, a program says to a JVM: "Try to execute this line of code, and if something goes wrong, and this method throws exceptions, please catch them, so that I could report this situation to a user." One try block can have multiple catch blocks, if more than one problem occurs. For example, when a program tries to read a file, the file may not be there - FileNotFoundException, or it's there, but the code has reached the end of the file - EOFException, etc.

public void getCustomers(){ 
  try{
    fileCustomers.read();
  }catch(FileNotFoundException e){
    System.out.println("Can not find file Customers");
  }catch(EOFException e1){
    System.out.println("Done with file read");
  }catch(IOException e2){
    System.out.println("Problem reading  file " + 
                                 e2.getMessage());
  }
}

If multiple catch blocks are handling exceptions that have a subclass-superclass relationship (i.e. EOFException is a subclass of the IOException), you have to put the catch block for the subclass first as shown in the previous example.

A lazy programmer would not bother with catching multiple exception, but will rather write the above code like this:

public void getCustomers(){ 
  try{
    fileCustomers.read();
  }catch(Exception e){
    System.out.println("Problem reading  file " + 
                        e.getMessage());
  }
}

Catch blocks receive an instance of the Exception object that contains a short explanation of a problem, and its method getMessage() will return this info. If the description of an error returned by the getMessage() is not clear, try the method toString() instead.

If you need more detailed information about the exception, use the method printStackTrace(). It will print all internal method calls that lead to this exception (see the section "Reading Stack Trace" above).

Clause throws

In some cases, it makes more sense to handle an exception not in the method where it happened, but in the calling method. Let's use the same example that reads a file. Since the method read() may throw an IOException, you should either handle it or declare it:

class CustomerList{
  void getAllCustomers() throws IOException{
    file.read(); // Do not use try/catch  if you are not handling exceptions here
  }

  public static void main(String[] args){
    System.out.println("Customer List");

    try{
      // Since the  getAllCustomers()declared exception,       
      // we have to either  handle  it over here, or re- 
      // throw it (see the throw clause explanation below)

     getAllCustomers();  
   }catch(IOException e){
     System.out.println("Sorry, the  Customer List is not 
                                               available");
  }
}

In this case, the IOException has been propagated from the getAllCustomers() to the main() method.

Clause finally

A try/catch block could be completed in different ways

  1. the code inside the try block successfully ended and the program continues,
  2. the code inside the try block ran into a return statement and the method is exited,
  3. an exception has been thrown and code goes to the catch block, which handles it
  4. an exception has been thrown and code goes to the catch block, which throws another exception to the calling method.
If there is a piece of code that must be executed regardless of the success or failure of the code, put it under the clause finally:

try{
  file.read();
}catch(Exception e){
  printStackTrace();
}
finally{
 file.close();
}

The code above will definitely close the file regardless of the success of the read operation. The finally clause is usually used for the cleanup/release of the system resources such as files, database connections, etc..

If you are not planning to handle exceptions in the current method, they will be propagated to the calling method. In this case, you can use the finally clause without the catch clause:

void myMethod () throws IOException{
  try{
    file.read();
  }
  finally{
    file.close();
  }
}

Clause throw

If an exception has occurred in a method, you may want to catch it and re-throw it to the calling method. Sometimes, you might want to catch one exception but re-throw another one that has a different description of the error (see the code snippet below).

The throw statement is used to throw Java objects. The object that a program throws must be Throwable (you can throw a ball, but you can't throw a grand piano). This technically means that you can only throw subclasses of the Throwable class, and all Java exceptions are its subclasses:

 
class CustomerList{

  void getAllCustomers() throws Exception{
    try{
      file.read(); // this line may throw an exception
    } catch (IOException e) {
      // Perform some internal processing of this error, and _
      throw new  Exception (
        "Dear Friend, the file has problems..."+ 
                                     e.getMessage());
      }
    }

    public static void main(String[] args){
      System.out.println("Customer List");

      try{
        // Since the  getAllCustomers() declares an  
        // exception, wehave  to either  handle  it, or re-throw it
         getAllCustomers();
      }catch(Exception e){
        System.out.println(e.getMessage());
      }
   }
}

User-Defined Exceptions

Programmers could also create user-defined exceptions, specific to their business. Let's say you are in business selling bikes and need to validate a customers order. Create a new class TooManyBikesException that is derived from the class Exception or Throwable, and if someone tries to order more bikes than you can ship - just throw this exception:

class TooManyBikesException extends Exception{
  TooManyBikesException (String msgText){
     super(msgText);      
  }  
}

class BikeOrder{
  static  void validateOrder(String bikeModel,int quantity) throws TooManyBikesException{

  // perform  some data validation, and if you do not like 
  // the quantity for the specified model, do  the following: 
 
  throw new TooManyBikesException("Can not ship" + 
    quantity+" bikes of the model " + bikeModel +);
  }
}

class Order{
   try{   
     bikeOrder.validateOrder("Model-123", 50);

     // the next line will be skipped in case of an exception
     System.out.println("The order is valid");   
   } catch(TooManyBikes e){
      txtResult.setText(e.getMessage());
   }
}

In general, to make your programs robust and easy to debug, you should always use the exception mechanism to report and handle exceptional situations in your program. Be specific when writing your catch clauses - catch as many exceptional situations as you can predict. Just having one catch (Exception e) statements is not a good idea.

More Stories By Yakov Fain

Yakov Fain is a Java Champion and a co-founder of the IT consultancy Farata Systems and the product company SuranceBay. He wrote a thousand blogs (http://yakovfain.com) and several books about software development. Yakov authored and co-authored such books as "Angular 2 Development with TypeScript", "Java 24-Hour Trainer", and "Enterprise Web Development". His Twitter tag is @yfain

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Virendra Mehta 04/03/05 05:25:58 PM EDT

It is also easy to abuse this facility (see my article at http://www.informit.com/articles/article.asp?p=337136) and that can cause serious performance bottlenecks!

@ThingsExpo Stories
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
Elon Musk is among the notable industry figures who worries about the power of AI to destroy rather than help society. Mark Zuckerberg, on the other hand, embraces all that is going on. AI is most powerful when deployed across the vast networks being built for Internets of Things in the manufacturing, transportation and logistics, retail, healthcare, government and other sectors. Is AI transforming IoT for the good or the bad? Do we need to worry about its potential destructive power? Or will we...
SYS-CON Events announced today that Daiya Industry will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Daiya Industry specializes in orthotic support systems and assistive devices with pneumatic artificial muscles in order to contribute to an extended healthy life expectancy. For more information, please visit https://www.daiyak...
SYS-CON Events announced today that SIGMA Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. uLaser flow inspection device from the Japanese top share to Global Standard! Then, make the best use of data to flip to next page. For more information, visit http://www.sigma-k.co.jp/en/.
SYS-CON Events announced today that B2Cloud will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. B2Cloud specializes in IoT devices for preventive and predictive maintenance in any kind of equipment retrieving data like Energy consumption, working time, temperature, humidity, pressure, etc.
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp em...
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
SYS-CON Events announced today that Nihon Micron will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...
SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
SYS-CON Events announced today that Suzuki Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Suzuki Inc. is a semiconductor-related business, including sales of consuming parts, parts repair, and maintenance for semiconductor manufacturing machines, etc. It is also a health care business providing experimental research for...
While some developers care passionately about how data centers and clouds are architected, for most, it is only the end result that matters. To the majority of companies, technology exists to solve a business problem, and only delivers value when it is solving that problem. 2017 brings the mainstream adoption of containers for production workloads. In his session at 21st Cloud Expo, Ben McCormack, VP of Operations at Evernote, will discuss how data centers of the future will be managed, how th...
SYS-CON Events announced today that Ryobi Systems will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ryobi Systems Co., Ltd., as an information service company, specialized in business support for local governments and medical industry. We are challenging to achive the precision farming with AI. For more information, visit http:...
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
In his session at @ThingsExpo, Greg Gorman is the Director, IoT Developer Ecosystem, Watson IoT, will provide a short tutorial on Node-RED, a Node.js-based programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows using a wide range of nodes in the palette that can be deployed to its runtime in a single-click. There is a large library of contributed nodes that help so...
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
Agile has finally jumped the technology shark, expanding outside the software world. Enterprises are now increasingly adopting Agile practices across their organizations in order to successfully navigate the disruptive waters that threaten to drown them. In our quest for establishing change as a core competency in our organizations, this business-centric notion of Agile is an essential component of Agile Digital Transformation. In the years since the publication of the Agile Manifesto, the conn...