Home > Articles > Programming > Java

Robert C. Martin's Clean Code Tip #12: Eliminate Boolean Arguments

We join "The Craftsman," Robert C. Martin's series on an interstellar spacecraft where programmers hone their coding skills. In this twelfth tip in the series, the crew learns that Boolean arguments loudly declare that the function does more than one thing. They are confusing and should be eliminated.
Like this article? We recommend

October 31, 1945.   Cape Canaveral, Florida.

WHAM!....WHAm…WHam…Wham!....wham!...Dyson watched with a mixture of delight and terror as the distant Orion craft thrust itself into the sky. Though the nuclear detonations that drove it were small, only one kiloton each, they were still impossibly bright even through his goggles. The sound that made it through the walls of the bunker slammed into him every two seconds as the explosions hurled the ship away.

This was the fifth and final launch today. They joined an armada of twelve ships heading for Mars. Six of those ships would return in a year; but with luck the remaining six ships and five hundred people would stay on Mars to build a permanent base and the beginnings of a colony.

Freeman Dyson stared at the bright two-second flashes of light, now nearing orbit. He wondered what it would look like, three days from now, when all twelve ships simultaneously restarted their engines and left orbit for Mars. He wanted to be with them. “Next year.” He said to himself. “Next year.”


Fri, 17 Mar 2002, 11:00

Jerry stood up and shook his fist at the ceiling. “I hate this!” He said, to no one in particular. “I fracking hate this!”

“Yikes! Jerry, what’s the problem?” I asked. Usually Jerry keeps his cool, so this had to be something unusual.

Jerry looked at me. His shoulders slumped, and he let out a frustrated sigh. “I’m just such an idiot sometimes.”

“I won’t argue with that!” Jasmine popped up from her workstation, a mischievous grin on her face.

“Yeah, yeah, I know Jazzy, I know. Thanks for the support.” He shot a quick grimace in her direction.

I pressed on. “What’s the problem? What is it you hate so much?”

“Oh, Alphonse, it’s just this problem I’ve been debugging for the last hour. The answer was right in front of me the whole time, but I just couldn’t see it.”

“You should have called me over to pair with you!” I said.

“Yeah Jerry!” Chided Jazmine, “The Hotshot there can fix anything.”

Jerry just glared at her until she sat back down, giggling. “Yeah, I probably should have. Here, look at this.”

I walked over to his workstation and saw the following code:

int status = controlRod.rotate(30, true)

“Ah! You’re working on the pile control system.”

“Yeah, we’re changing the rotation protocol on the control rods. Some egg-head physicist has decided that we should rotate the rods thirty degrees every month instead of fifteen.”

“OK.” I said. “So what’s the problem?”

Jerry sighed, and scrolled the screen forward a few lines. “Look at this.”

int status = fuelRod.rotate(0.5, true);

“Uh, OK. So this is rotating a fuel rod by half a degree. Are these lines of code related?”

Jerry’s mouth tightened. “No, but I thought they were.”

“I’m not following you, Jerry.”

“Yeah, I know. So here’s the deal. I needed to rotate the control rods by thirty degrees. So I found this line of code that rotated the fuel rods and I figured that the control rods would work the same. So I wrote the first code I showed you.”

“And it didn’t work?”

“It was strange. The control rod rotated alright, but it was always about 270 degrees instead of 30.”

“270? Is the rotate function broken?”

“No, I ran the tests for the rotate function over and over. I even looked at the code for the rotate function. It’s all just fine.”

“So what was the problem?”

Jerry looked at me sheepishly and pointed back to the screen, at the line that rotated the fuel rod by half a degree. “That’s not rotating half a degree.” He said.

“It’s not?”

“No, it’s rotating 90 degrees.”

“Huh?” What was he talking about?

“Yeah, somebody got lazy. Actually two people got lazy.”

“Jerry, how can rotating by .5 be 90? For that matter how can rotating by 30 be 270?”

“Actually, that 30 was a lot more than 270. It was 4.75 times around or just under 1,719 degrees.”

“OK, Jerry, you are blowing my mind here. What the frack are you talking about?”

“Do you see the Boolean arguments?”

“Yeah, they’re both true.”

“Right. What do you think they mean?”

“I don’t know, what?”

“Degrees or Radians.”

“Huh?” I blurted.

Jerry looked at me meaningfully. “They specify whether the argument is in degrees or radians.”

“OK, so true means degrees.”

“No.”

“Oh, so that was your problem! You thought the fuel rod was being rotated half a degree, and it was actually being rotated…uh…about pi over 6…about 30 degrees! Wait…you said 90.”

“No, you’ve got the wrong idea.”

“Huh?”

Jerry took a deep breath. “The rotate function for fuel rods always rotates the fuel rods by quarter of a turn. But it does so in half-second increments. The argument specifies the size of the increment.”

“Oh, OK, so it was using half-degree increments and would complete the rotation in, uh…, half-dgree, half-second … one degree per second… 90 seconds.”

“Yes, that’s right.”

“OK, so true means degrees.”

Jerry smiled, sadly. “Only half right.”

“Half right?”

“Yeah, true means degrees for the fuel rods. But true means radians for the control rods.”

“Oh! OUCH!”

“Yeah, I was rotating the control rods by 30 radians.”

“Oh, so you just assumed that since true meant degrees for fuel rods, that it meant degrees for control rods too.”

“Yeah, but I should’t have.”

“Wow, yeah, someone got lazy. They didn’t use the same meaning for true in the rotate function.”

“Actually, there never should have been a Boolean argument. There should have been two rotate functions named rotateByDegrees and rotateByRadians.”

I nodded. “Yeah, that makes a lot more sense. Nobody’d get confused by that. So, who’s the other guy who got lazy?”

“The guy who named the fuel rod rotate function. He should have given it a name like incrementallyRotateQuarterTurn.

“Yeah, I see your point. But…why were you so upset? You solved the problem. You should be happy.”

“I was upset, Alphonse, because both of those lazy people were me.”

I chortled at that. Shook my head, and went back to my workstation. I scanned through Mr. C.’s rules looking for the rule about flag arguments.

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