20
Thu, Jun
3 New Articles

TechTip: Getting Started with the Eclipse Java Debugger

Java
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Eclipse is a mature, stable, and feature-rich integrated development environment (IDE) in which a wide variety of programming languages are supported, namely Java. Although we all like to think that we write perfect code, we don't. As such, we often find ourselves mercilessly sifting through our code, trying to debug a problem, all whilst polluting it with System.out.println("Got here!"); and System.out.println("Got there!"); lines. It turns out there's a far better way to debug.

Eclipse has an excellent debugger that's available out of the box. A debugger is a tool that can be used to set breakpoints (i.e., a point of execution at which the program will pause) and allow you to precisely see what's going in within your program.

(Note: The steps presented in this article are also compatible with IBM's Rational Application Developer product.)

Great! So Where Do I Start?

As an initial point of reference, it's assumed that you've already created an Eclipse-based Java project and you're now to the point where you want to debug a problem. The following block of code illustrates a simple program with an embedded problem for the sake of this tutorial:

package example.debugger;

public class MyMain {
      private static class Person {
            private String name;
            private int age;

            public Person(String name, int age) {
                  this.name = name;
                  this.age = age;
            }

            public int getAge() { return age; }
            public String getName() { return name; }
      }

      public static void main(String[] args) {
            Person p1;
            Person p2;

            p1 = new Person("John", 35);
            p2 = new Person(null, 28);
            System.out.println("The length of Person 1's name is: 

" + p1.getName().length());
            System.out.println("The length of Person 2's name is: 

" + p2.getName().length());
      }
}

Executing this program results in a NullPointerException being thrown from MyMain.java:25. Obviously, the problem is a result of calling the length() method on the null object p2.getName(), but let's walk through using the debugger anyway.

Step 1: Set Your Breakpoint(s)

In this case, you'll want to open the source code for MyMain.java in your source window. Then you can position the cursor on the problematic line.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290700.png

Figure 1: Open the source code for MyMain.java in the source window. (Click images to enlarge.)

Now press CTRL+SHIFT+B to set a breakpoint on the line; a red dot should appear to the left of the line of code to indicate that a breakpoint has been activated on that line.

Step 2: Open the Debug Perspective

To open the debug perspective, click on Window>Open Perspective>Debug, as shown below.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290701.png

Figure 2: Click on Window>Open Perspective>Debug.

As shown below, your screen will be segmented into various regions.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290702.png

Figure 3: The screen is segmented into regions.

Circled in red is a list of all breakpoints that you've defined for your program. Here, you have only one breakpoint defined, but in many cases it's desirable to have several set. You can also right-click any of the breakpoints and work with their properties. For example, you can configure a breakpoint to take effect only after it's been "touched" n times, or some other user-defined predicate is satisfied, etc.

Step 3: Run the Application in Debug Mode

Now that your breakpoint has been set and you're in the debug perspective, it's time to run your program so you can see what's going on. Click on Run>Debug Last Launched (or simply press F11) to debug the application.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290703.png

Figure 4: Click on Run>Debug Last Launched to debug the application.

Now the program will start running until a breakpoint is encountered and all of its conditions are met (e.g., if you set its "hit count" to 5, the breakpoint will need to be encountered five times), at which point the program will pause, as shown below.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290704.png

Figure 5: The program has paused.

You can see in the console window that the first line to standard out was successfully written, but now the program is halted on the execution of line highlighted in green (i.e., the line that originally threw the NullPointerException).

Let's now take a look at the internals of the program to diagnose the problem. As shown below, by clicking on the Variables tab in the top right corner, you can see a variety of information about the state of the application.

http://www.mcpressonline.com/articles/images/2002/TechTip%20-%20Eclipse%20DebuggerV3--06290705.png

Figure 6: Click the Variables tab to see information about the state of the application.

You can see that the name member of p2 is null, which explains the NullPointerException. Now that you know what was causing the exception, you can proceed to set another set of breakpoints to help determine how the name member of p2 got set to null. To continue running the program, use the buttons on the debug toolbar (circled above) to resume execution, step into the breakpoint, or step over the breakpoint.

Wrapping Up

Although the example showed a trivial problem to fix, you can see the power of having the Eclipse debugger at your disposal. It allows you to set breakpoints anywhere in your program and walk through the runtime logic line by line. You can also use it to debug a multi-threaded program and watch what's happening on a thread-by-thread basis.

Although it's beyond the scope of this article, it's worth noting that you can indeed debug remote programs. The example shown here demonstrates debugging a local program, but Eclipse also has support to debug remotely, and there are a lot of good Web-based articles that explain the process.

Wave "Goodbye" to print lines and say "Hello" to the debugger!

Joe Cropper is a Software Engineer at IBM in Rochester, Minnesota. Joe works as part of the System i Software Final System Test team, and his areas of expertise include database, multi-tiered client-server technologies, and a variety of object-oriented programming languages. Joe can be reached via email at This email address is being protected from spambots. You need JavaScript enabled to view it..

Joe Cropper is a Software Engineer at IBM in Rochester, Minnesota. He works as part of the Cloud Systems Software Development organization, focusing on virtualization and cloud management solutions. Joe has held a number of roles in other organizations as well, ranging from IBM i and Electronic Support. His areas of expertise include virtualization and cloud management, OpenStack, Java EE, and multi-tiered applications. Joe can be reached via email at This email address is being protected from spambots. You need JavaScript enabled to view it..

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: