Home > Articles > Programming > Java

Practical Java Praxis 63: Define and Implement Immutable Classes Judiciously

  • Print
  • + Share This
Immutable objects in Java can provide a valuable service because they are inherently thread-safe. However, any performance gains achieved by immutable objects can be negated by the extra code that you sometimes must implement to support them. In this brief article, Java expert Peter Haggar discusses the best way to work with immutable classes.
Like this article? We recommend Immutable objects in Java can provide a valuable service because they are inherently thread-safe. However, any performance gains achieved by immutable objects can be negated by the extra code that you sometimes must implement to support them. In this brief article, Java expert Peter Haggar discusses the best way to work with immutable classes.

This content is excerpted from Peter's book, Practical Java, (Addison-Wesley, 2000).

Immutable objects can be a valuable and necessary construct in object-oriented programming. Sometimes you want to prohibit an object from ever being changed. By definition, an immutable object is an object and any object it references that does not change after construction. The object is, therefore, immutable for its lifetime. Immutable classes are commonly used to represent strings, colors, and numeric values.

Immutable objects provide a valuable service. Because they guarantee that their state cannot change after construction, they are inherently thread-safe. Thread concurrency issues are relevant when one thread can change data while another thread is reading the same data. Because an immutable object never changes its data, synchronizing access to it is not needed.

Depending on the design of the immutable object, this lack of synchronization can have enormous performance benefits. However, any performance gains achieved by immutable objects can be negated by the extra code that you sometimes must implement to support them. For example, implementing immutable objects often requires you to implement cloning, which can be expensive. Cloning is discussed in detail in the second article in this series.

While immutability is a property of an object, it must be coded explicitly. There is no keyword in Java to specify immutability. However, several aspects of a class's definition and implementation enable immutability:

  • Declare all data in the class private.

  • Provide only getter methods. No setter methods are allowed.

  • Declare the class final.

  • Clone mutable objects before returning a reference to them from a getter method (see the second article in this series).

  • Clone objects provided to the constructor that are references to mutable objects (see the second article in this series).

  • Set all data contained in the class in the constructor.

Because an immutable object cannot be changed, all data must be declared private. If it is not, the data—and, therefore, the object—can be changed.

No setter methods are allowed because they change class data. In addition, the class must be declared final, to prevent its being subclassed. A subclass could provide setter methods or override one of the getter methods and return a value not consistent with the base class.

Furthermore, before a reference to any mutable object may be passed to the constructor or returned from a getter method, the object must be cloned first. If it is not, immutability can be lost (see the second article in this series). Because of these restrictions, all data relevant to the class's immutability must be set by the class constructor. Consider the following immutable class:

final class PinNumbers
{
  private String acctOwner;
  private int checkingAcctPin;
  private int savingsAcctPin;



  PinNumbers(String owner, int cPin, int sPin)
  {
    acctOwner = owner;
    checkingAcctPin = cPin;
    savingsAcctPin = sPin;
  }
  public String accountOwner()
  {
    return acctOwner;
  }
  public int checkingPin()
  {
    return checkingAcctPin;
  }
  public int savingsPin()
  {
    return savingsAcctPin;
  }
  //...
}

This class is declared final to prevent subclassing. All of its data is declared private, and it provides only getter methods to access that data. Furthermore, all of the data is set by the constructor. These attributes ensure that an object of this class cannot change after it is created. You must also be sure that none of the methods for the class changes the internal data of the class and thereby breaks immutability.

This class does not have to clone any data because the only data types that it receives in the constructor, or returns from its methods, are primitive types and object references to immutable objects. Primitive types are not objects, and, therefore, cloning makes no sense for them. The String class is immutable, so there is no need to clone it. The second article in this series discusses the details of cloning mutable objects.

About the Author

Peter Haggar is a senior software engineer with IBM in Research Triangle Park, North Carolina, and the author of the best-selling book Practical Java, published by Addison-Wesley. Having worked on development tools, class libraries, and operating systems, he has a broad range of programming experience. At IBM, Peter works on emerging Java technology and, most recently, on real-time Java. He is also a frequent technical speaker on Java technology at numerous industry conferences. Peter received his bachelor of science degree in computer science from Clarkson University. He can be contacted at haggar@us.ibm.com.

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