Home > Articles

Debugging

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

Debugging Standalone Java Code

Start Eclipse if it is not already running. Create a new project, a Java class, and a JUnit test to go with it. If you created the Calculator project from Chapter 2, "Writing and Running a Java Application," then simply refer to that project for the next few pages. If you have not created the Calculator project, perform the following steps:

  1. Press Ctrl+N and from the New dialog select Java Project and click Next. In the Project Name field enter "Calculator".

  2. Leave the Location section set to its default workspace location.

  3. In the Project Layout section, select Create Separate Source and Output Folders and click Configure Defaults. When the Preferences dialog opens, click the Folders button. Leave the Source Folder Name set to src, but change the Output Folder Name to classes. Click OK.

  4. Click Finish.

Now you need to create two classes: the class to be run and the class that tests it. In order to create them, perform the following steps:

  1. Press Ctrl+N to open the New dialog. If only two selections appear, put a check next to Show All Wizards toward the lower-left corner of the dialog. When the remaining resource wizards appear, select Java, Class and click Next.

  2. On the Java Class page, enter a Package of eclipse.kickstart.example and Class Name of SimpleCalculator. Click Finish.

  3. Select SimpleCalculator in the Package Explorer view.

  4. Press Ctrl+N again to open the New dialog. Select Java, JUnit, JUnit Test Case and click Next.

  5. On the JUnit Test Case page, all the test case information should be filled in. If it is not, click Cancel, select SimpleCalculator, and return to step 4. If the JUnit Test Case page is filled in, check setUp() and tearDown() and click Finish.

If you did not implement the SimpleCalculator class from Chapter 2, open the SimpleCalculator class and add the following code:

package eclipse.kickstart.example;


import java.text.DecimalFormat;

public class SimpleCalculator implements Calculator {


  private static final String USAGE =
"java eclipse.kickstart.example.SimpleCalculator val1 val2";

  public int add(int i, int j) {
    return I + j;
  }

}

If you did not implement SimpleCalculatorTest in Chapter 2, open the SimpleCalculatorTest class and add the following methods (if you already implemented this class then just add the code in bold):

package eclipse.kickstart.example;


import junit.framework.TestCase;


public class SimpleCalculatorTest extends TestCase {


  private Calculator _calculator;


  public void testAdd() {
    int expected = 0;
    int actual = _calculator.add(0, 0);
    assertEquals(expected, actual);


    expected = 1;
    actual = _calculator.add(0, 1);
    assertEquals(expected, actual);


    try {
      actual = _calculator.add(Integer.MAX_VALUE, 1);
      fail("add() passed on an overflow value.");
    } catch (RuntimeException e) {
      // If we come here then an exception was
      // thrown and the test passed.
    }
    }

  protected void setUp() throws Exception {
    _calculator = new SimpleCalculator();
  }

  protected void tearDown() throws Exception {
    _calculator = null;
  }

}

The code in the try/catch block is checking if SimpleCalculator's add() method can handle an integer value overflow. The expected behavior is for the method to throw an exception if the value is too large to contain in an int, and the caller then needs to do something about it. If the test passes, you should get a green bar in the JUnit GUI. (It will fail, of course. Make the code changes, select SimpleCalculatorTest, and then select Run, Run As, JUnit Test. Red bar!)

Let's set a simple breakpoint in SimpleCalculator's add() method at the line that reads return i + j. Double-click in the editor margin to the far left, just past the line numbers. A blue dot appears. Press F11 or select from the main menu Run, Debug As, JUnit Test. The debugger stops the code in add() and displays the various stack frames in the Debug view. Select the stack frame for SimpleCalculator.testAdd() (see Figure 3.3). The selected code is for the first of the three tests run in testAdd(). Because you want the debugger to stop on the third test, you have two choices on how to proceed: You can either set the breakpoint in the testAdd() method of SimpleCalculatorTest or you can modify the breakpoint to become activated based on a condition. For the purposes of this example, you are going to do the latter.

Figure 3.3Figure 3.3 The Debug perspective with the stack frame for SimpleCalculatorTest selected.

Go to the Breakpoints view in the upper-right corner (see Figure 3.4). If it is not visible, click the Breakpoints tab. Double-click the breakpoint in the Breakpoints view to bring the editor forward with the breakpoint line selected. Because you are debugging the code and you are at the particular line, you will also see an arrow pointing toward the line in question. Right-click where the blue dot is to open a pop-up menu and then select the Breakpoint Properties menu item. This menu item will open a Properties dialog (see Figure 3.5) for this breakpoint, allowing you to do the following:

  • Disable the breakpoint.

  • Set the breakpoint to be called only after it has been accessed a certain number of times.

  • Set the breakpoint to halt execution when a condition has been met.

Figure 3.4Figure 3.4 The Breakpoints view displaying the single available breakpoint.

Figure 3.5Figure 3.5 The Breakpoint Properties dialog.

Let's try all three. Uncheck Enabled and click OK. To resume execution, go to the Debug view and click the right-pointing triangle or just press F8. The breakpoint, now disabled, was ignored, and the test completed with the red bar.

Reenable the breakpoint by right-clicking the breakpoint and, when the Properties dialog opens, checking Enabled. Now check Hit Count and enter 3 into its input field. Click OK. Press F11 to restart the debug session.

Now, when the breakpoint is hit in the add() method, it will only stop the third time the breakpoint is accessed. To prove it, select the stack frame just below the breakpoint frame (the one for SimpleCalculatorTest.testAdd()). Instead of stopping at the first call to add() in testAdd(), it has stopped at the third call. This is useful when you have a bug that only surfaces when a piece of code executes a certain number of times. Press F8 to resume and complete the test run (still a red bar!).

What about those situations where you need to stop only after a particular condition is met? For example, when the value of a variable enters a certain range, you would like the breakpoint to activate. Once again, right-click the breakpoint and open the Breakpoint Properties dialog. Uncheck Hit Count and check Enable Condition. In the text area, enter i == Integer.MAX_VALUE. Code Assist is active in this text area, so feel free to use it in completing Integer and MAX_VALUE. Click OK and press F11 to restart the debugging session. Click the Variables tab to bring the Variables view forward. The variable i is set to 2147483647, which, not coincidentally, equals Integer.MAX_VALUE. Just to double-check, click the stack frame for SimpleCalculatorTest.testAdd() again. The breakpoint stopped at the third test once again. Press F8 to complete the test run.

In case you are tired of seeing the red bar, add the following code to SimpleCalculator's add() method:

  public int add(int i, int j) {
    int result = 0;


    long op1 = i;
    long op2 = j;
    long longResult = op1 + op2;
    if (longResult > Integer.MAX_VALUE) {
      throw new RuntimeException(
          "The addition of the values would result in an overflow.");
    } else {
      result = (int) longResult;
    }
    return result;
  }

Let's look at the Expressions view before we move away from the SimpleCalculator example. Set a breakpoint at the first line of the add() code and another at the if statement. Press F11 to restart the debug session. When the breakpoint stops at the top of add(), select the variable longResult, right-click to open the pop-up menu, and select Watch. Because longResult is a local variable, the debugger complains that it cannot evaluate the expression. Press F8 to resume execution to the next breakpoint. Now that longResult is declared, the Expressions view shows the variable set to 0 (which is correct because the first JUnit test checked that 0 + 0 equals 0). Press F8 again, and the Expressions view once again complains that longResult has encountered evaluation errors. Press F8 again, and now longResult equals 1.

Continue pressing F8 until the program completes. If you want to clear the Debug view of all the terminated processes you created, click the fifth icon from the left in the menu bar of the Debug view (the one that looks like a stack of rectangles). To remove the breakpoints, click the Breakpoints tab, right-click in the Breakpoints view, and select Remove All from the pop-up menu.

Close all the editors.

Debugging Server-Side Java

Server-side debugging of Java code is not supported in Eclipse, but it can be added through additional plug-ins. The section titled "Debugging Servlets, JSPs, and EJBs" of Chapter 9, "J2EE and the MyEclipse Plug-In," covers J2EE development using the MyEclipse plug-in, including the installation of the plug-in, how to set up the configuration of a server, implementing a servlet and JSP, and debugging server-side components within Eclipse.

Once the plug-in J2EE support is installed and the server configuration is entered, debugging proceeds as before. Set breakpoints, examine variables, edit files, and observe the various views in the same way you would for a standalone.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020