Home > Articles > Programming > Java

  • Print
  • + Share This

Enough Introduction...Let's Debug Already!

You start up your debugging session by using a specialized version of the Java interpreter. To debug a Java class, simply invoke the jdb tool with the name of the Java class you want to debug as an argument:

jdb YourClassName

The syntax above would run jdb on the class named YourClassName.class. Doing so runs the program using a special version of the Java interpreter that the debugger can interact with.

We Need Something to Debug

For purposes of studying jdb's offerings, we will use jdb on the Java class shown in Listing 1. (You can download this class here.) Although we are trying to troubleshoot a Java class, you need to make sure that jdb has access to both the .class file of you Java class as well as the source code of the class (that is, the .java source file).

Listing 1 The DebugMe class

 1 public class DebugMe {
 2   public static void main(String[] args) {
 3       DebugMe debugMe = new DebugMe();
 4       System.out.println("Example program for debugging");
 5       int a = 10;
 6       int b = 7;
 7       int c = debugMe.adder(a, b);
 8       System.out.println("Result= " + c);
 9   }
10   public int adder(int x, int y) {
11       System.out.println("Adding " + x + "+" + y);
12       int z = x + y;
13       return z;
14   }
15 }

Our class is intentionally kept simple. We have a simple adder method that adds two incoming integers and returns the sum. You'll see later why I structured the code the way I did. It is designed to demonstrate the usage of the debugger.

Compiling to Get More Info

When you want to debug an application, you need to compile your class using the –g option. This compile option specifies that extra information be added to the class file that is generated. This extra information is used in the debugging process. The –O option should not be used when compiling a class you want to debug. Using –O means that you want to optimize your class file. This optimization process might render a class file that does not necessarily match up with the class file's source code, thus not allowing us to use the debugger properly.

Let's Do Some Debugging

We can set breakpoints

  • At specific line numbers of the source code

  • When a method is called

  • When an exception is caught

Let's fire up the debugger for the class shown in Listing 1 with this command:

C:\j2sdk1.4.2_03\bin>jdb DebugMe
Initializing jdb ...
>

It is at the > prompt that we control our debugger.

Setting Breakpoints

We can set a breakpoint at the method level by using this syntax:

stop in classname.methodname

So in our case, we can use this command:

stop in DebugMe.adder 

Doing this, you will see a response of the following to specify that we want a breakpoint at the first line of the adder method of the DebugMe class:

> stop in DebugMe.adder
Deferring breakpoint DebugMe.adder.
It will be set after the class is loaded.

Similarly, we can specify that we want to add a breakpoint to a specific line number by using this syntax:

stop at classname:lineNumber

If we want to have a breakpoint at line number 7, we would use the following command:

stop at DebugMe:7

Listing and Clearing Breakpoints

You can list all the breakpoints you set by using the clear command with no arguments.

For our work above, we would see the following response:

> clear
Breakpoints set:
    breakpoint DebugMe.adder
    breakpoint DebugMe:7

If we want to remove a breakpoint, we can use this syntax:

clear classname:lineNumber

NOTE

Note that if you set your breakpoint using the stop in syntax (that is, setting at method level), you still need to specify the line number where the method begins if you want to remove it.

Beginning Execution

We begin the execution of the program by using the run command at the prompt. When we do so, we see the following:

> run
run DebugMe
Set uncaught java.lang.Throwable
Set deferred uncaught java.lang.Throwable
>
VM Started: Set deferred breakpoint DebugMe:7
Set deferred breakpoint DebugMe.adder
Example program for debugging

Breakpoint hit: "thread=main", DebugMe.main(), line=7 bci=22
7        int c = debugMe.adder(a, b);

Now that we have hit a breakpoint, we can enter some commands:

locals: As shown below, locals shows us the local variables currently in use and their values:

main[1] locals
Method arguments:
args = instance of java.lang.String[0] (id=270)
Local variables:
debugMe = instance of DebugMe(id=271)
a = 10
b = 7

Notice that because the breakpoint was defined at line 7, line 7 has not yet executed. Accordingly, we are not shown variable c because it has not been created.

print name: Shows us the value of the variable or object specified by name. If, for example, we want to see the contents of variable a:

main[1] print a
 a = 10

list: Shows some of the source before and after where the breakpoint was set. Pay particular attention to "=>", which shows where the execution is paused:

main[1] list
3        DebugMe debugMe = new DebugMe();
4        System.out.println("Example program for debugging");
5        int a = 10;
6        int b = 7;
7 =>      int c = debugMe.adder(a, b);
8        System.out.println("Result= " + c);
9    }
10   public int adder(int x, int y) {
11       System.out.println("Adding " + x + "+" + y);
12       int z = x + y;

Using the command cont, we can continue the running of the program until another breakpoint is hit. Notice that the debugger moves into the adder method because we specified a breakpoint there earlier:

main[1] cont
>
Breakpoint hit: "thread=main", DebugMe.adder(), line=11 bci=0
11       System.out.println("Adding " + x + "+" + y);

The step command allows us to move to the next line and pause execution there. Take a look at the portion of the debugging session below; we perform a series of steps followed by locals to show how our program is executed line by line, and how our local variable values are affected after each line is executed:

main[1] step
> Adding 10+7

Step completed: "thread=main", DebugMe.adder(), line=12 bci=34
12       int z = x + y;

main[1] locals
Method arguments:
x = 10
y = 7
Local variables:
main[1] step
>
Step completed: "thread=main", DebugMe.adder(), line=13 bci=38
13       return z;

main[1] locals
Method arguments:
x = 10
y = 7
Local variables:
z = 17

The exit command can be used any time in the debugger to end the debugging session.

  • + 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