Home > Articles > Programming > Java

Java Nuts and Bolts: Copy Constructors, Cloning, and Linked Structures

📄 Contents

  1. Factories and the Recurring Need to Copy Objects
  2. Linked Java Structures
  3. Running the Supplied Code
  • Print
  • + Share This
Do you shy away from complicated programming language techniques? Have you never quite had the time to understand the finer details of copy constructor or linked lists? You may be missing out on some powerful problem-solving mechanisms, and author Stephen Morris leads you through them.
Like this article? We recommend

Like this article? We recommend

I've often thought that mathematics is probably the worst taught of all subjects. If a student isn't lucky enough to build a good foundation early on, then he can look forward to a lifetime of unnecessary mathematical angst. It's a shame because mathematics is a lot like programming—often in both fields there is a multiplicity of solutions, which means that mathematics and programming exhibit many similarities.

The one thing that sets mathematicians and programmers apart is the ability to cut down on work while still getting the job done. I discuss this in detail in my upcoming eBook, but it's worth mentioning that economy of effort is a highly useful skill. The best programmers tend to rapidly get stuck into the hardest part of a given solution; this approach helps reduce the risk of a given project. An important tool in this ability to reduce risk is a deep understanding of the vernacular of a programming language—this can save much effort, i.e., if you take the time to learn the fine details, you'll reap the rewards later on.

Every programming language has its own special wrinkles, and knowledge of these can help in rapidly solving specific problems. In this article, I'll look at three areas of Java that often pass under the radar of programmers: copy constructors, cloning, and linked structures. Not fully understanding these areas of Java can result in reduced modularity and weak encapsulation—for example, not using copy constructors can easily result in unnecessary object instantiations. The same is true for cloning. Likewise, not using linked data structures can make for an unnecessarily complex data model.

Once you get to grips with these three concepts, you'll be programming in a less complex and more object-oriented spirit. So, without further ado, let's get started.

Factories and the Recurring Need to Copy Objects

The factory concept is a widely used design pattern in Java and other object-oriented programming languages. One of the design patterns that fulfils the needs of a factory is called the abstract factory. The purpose of the factory is for creating families of related or dependent objects without specifying concrete classes. Concrete classes are used to implement the specific object requirements. However, there is a lighter requirement than a factory that often arises where you simply want to copy an object.

When you copy an object, do you want an exact copy or do you want a new individual copy? In most cases, you will want a new individual copy and an easy way to do this is to use the copy constructor. Let's start the code section with the really simple class illustrated in Listing 1.

public class Document implements Copyable
{
  private String name;
  private Date created;

  public Document(String docName, Date creationDate){
    name = docName;
    created = new Date(creationDate); }

  public Document(Document original){
    if (original == null){
      System.out.println("Error - null object.");
      System.exit(0); }

    name = original.name;
    created = new Date(original.created); }

  public Object copy() {
    return new Document(name, created);}

  public String toString(){
    return (name + ", " + created);}
}

Listing 1 A Class with a Copy Constructor

In Listing 1, I present a very simple class that models a business document. The idea here is to use this class as a kind of template for different business document types, such as invoices, receipts, statements, and so on. If you run your own business, you get used to these pesky documents! So, when you want to instantiate an invoice object, you could use code such as that illustrated in Listing 2:

Document invoice = new Document("Invoice", new Date("April", 1, 2007));

Listing 2 Document Object Instantiation

In Listing 2, I create a document object instance. The document is simple: It is typed as an invoice and it has a creation date. Obviously, a real business document management system would have many more attributes, such as revision numbers, links to other documents, and so on.

So, nothing too surprising appears in Listings 1 and 2; you can now create objects of the Document class, and each such object is provided with an object reference. For example, in Listing 2 the reference is called invoice. A real-world application would typically include methods that allow operations specific to the object; for example, an invoice object would typically allow you to mark the underlying invoice as paid or unpaid. So, it's likely that you would subclass the Document class to implement the different business document classes. I haven't done any sub classing in this case, but you get the idea.

At this point, we have a bunch of instantiated Document objects as a result of running the code in Listing 3.

Document invoice = new Document("Invoice", new Date("April", 1, 2007));
Document receipt = new Document("Receipt", new Date("May", 11, 2007));
Document statement = new Document("Statement", new Date("January", 31, 2007));

Listing 3 A Bunch of Objects

Let's now suppose you want to create a copy of one of the objects in Listing 3. This is similar to the case when you want to make a copy of a Word document without changing the original. In other words, you want to create an independent copy—this is a job for the copy constructor. Listing 4 illustrates the copy constructor drawn from the code in Listing 1.

public Document(Document original)
{
if (original == null)
{
System.out.println("Error - null object.");
System.exit(0);
}
name = original.name;
created = new Date(original.created);
}

Listing 4 The Copy Constructor

The clever part about Listing 4 is that it results in the instantiation of a new and independent object. This copy constructor can be invoked as follows:

Document anotherInvoice = new Document(invoice);

To determine if the objects in Listing 3 are unique with respect to the object produced by the copy constructor, you can just run the code shown in Listing 5.

System.out.println("Hash codes: " +
    invoice.hashCode() + " " +
    receipt.hashCode() + " " +
    statement.hashCode() + " " +
    anotherInvoice.hashCode());

Listing 5 Are the Objects Unique?

The code in Listing 5 produces the Listing 6 output on my desktop PC:

Hash codes: 4384790 9634993 1641745 11077203

Listing 6 Hash Codes Indicating Uniqueness

As you can see from Listing 6, each object has a unique hash code, which means what? Generally speaking, in as far as is reasonably practical, Java objects that are not equal have different hash codes. This is a useful property when you want to insert such objects in a hash table based data structure. Comparing hash codes in this fashion is what's called a shallow comparison. A deep comparison involves comparing data members for each object.

So much for the copy constructor. What about cloning? Suppose you don't want to implement a copy constructor but you still want to be able to copy a given object instance. Java supports a mechanism that allows this with the advantage of a somewhat lower footprint than a copy constructor. This is provided by a special purpose interface called Copyable. If you look at the first line in Listing 1, you'll see the line:

public class Document implements Copyable

This indicates that the class implements the Copyable interface with the following code in Listing 7:

public interface Copyable
{
  public Object copy();
}

Listing 7 Implementation of the Copyable interface

The code in Listing 7 is very simple: It comprises a single method that returns a Java Object and that's all there is to it! So, what happens when you run the method in Listing 7? Listing 8 illustrates the code that calls the copy() method:

System.out.println("Creating a new document using the copy() method.");
Document clonedDoc = (Document)anotherInvoice.copy();
System.out.println("A document was copied.");
System.out.println("Original object hash code = " + anotherInvoice.hashCode());
System.out.println("Copied object hash code = " + clonedDoc.hashCode());

Listing 8 Copying a New Object Instance

It's very simple: The second line in Listing 8 invokes the copy() method. The remainder of the code just prints the hash code for the original object and the cloned object. As you can see in Listing 9, the hash codes indicate that the two objects are unique.

Creating a new document using the copy() method.
A document was copied.
Original object hash code = 11077203
Copied object hash code = 14576877

Listing 9 Unique Hash Code of a Cloned Object

As you can see, copying Java objects is pretty straightforward. Let's now take a look at the area of linked Java structures.

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