Home > Articles > Programming > Java

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

This chapter is from the book

Prototype

Pattern Properties

Type: Creational, Object
Level: Single Class

Purpose

To make dynamic creation easier by defining classes whose objects can create duplicates of themselves.

Introduction

In the PIM, you want to be able to copy an address entry so that the user doesn't have to manually enter all the information when creating a new contact. One way to solve this is to perform the following steps:

  1. Create a new Address object.
  2. Copy the appropriate values from the existing Address.

While this approach solves the problem, it has one serious drawback—it violates the object-oriented principle of encapsulation. To achieve the solution mentioned above, you have to put method calls to copy the Address information, outside of the Address class. This means that it becomes harder and harder to maintain the Address code, since it exists throughout the code for the project. It is also difficult to reuse the Address class in some new project in the future.

The copy code really belongs in the Address class itself, so why not instead define a "copy" method in the class? This method produces a duplicate of the Address object with the same data as the original object—the prototype. Calling the method on an existing Address object solves the problem in a much more maintainable way, much truer to good object-oriented coding practices.

Applicability

Use the Prototype pattern when you want to create an object that is a copy of an existing object.

Description

The Prototype pattern is well named; as with other prototypes, it has an object that is used as the basis to create a new instance with the same values. Providing a "create based on existing state" behavior allows programs to perform operations like user-driven copy, and to initialize objects to a state that has been established through use of the system. This is often preferable to initializing the object to some generic set of values.

Classic examples for this pattern exist in graphic and text editors, where copy-paste features can greatly improve user productivity. Some business systems use this approach as well, producing an initial model from an existing business object. The copy can then be modified to its desired new state.

Implementation

The Prototype class diagram is shown in Figure 1.4.

Figure 1.4 Prototype class diagram

To implement Prototype, you need:

  • Prototype – Provides a copy method. That method returns an instance of the same class with the same values as the original Prototype instance. The new instance can be a deep or shallow copy of the original (see the Benefits and Drawbacks section of this pattern).

Benefits and Drawbacks

The Prototype is helpful because it allows systems to produce a copy of a usable object, with variables already set to a (presumably) meaningful value, rather than depending on some base state defined in the constructor. An example of Prototype use is shown in Figure 1.5.

Figure 1.5 Example of Prototype use

A key consideration for this pattern is copy depth.

  • A shallow copy duplicates only the top-level elements of a class; this provides a faster copy, but isn't suitable for all needs. Since references are copied from the original to the copy, they still refer to the same objects. The lower-level objects are shared among copies of the object, so changing one of these objects affects all of the copies.

  • Deep copy operations replicate not only the top-level attributes, but also the lower-level objects. This typically takes longer than shallow copy operations, and can be very costly for objects with an arbitrarily complex structure. This makes sure that changes in one copy are isolated from other copies.

By its nature, the clone method in Object supports only one form of copy. For cases where you must support multiple methods of post-creation initialization.

Pattern Variants

Pattern variants include the following:

  • Copy constructor – One variant of the prototype is a copy constructor. A copy constructor takes an instance of the same class as an argument and returns a new copy with the same values as the argument.

  • Example 1.17 Copy constructor

    public class Prototype {
     private int someData;
     // some more data
     public Prototype(Prototype original) {
      super();
      this.someData = original.someData;
      //copy the rest of the data
     }
     // rest of code
    }

    An example is the String class, where you can create a new String instance by calling for instance: new String("text");

    The benefit of this variant is that the intention of creating a new instance is very clear, but only one type of copy (deep or shallow) can be executed. It is possible to have a constructor that can use both. The constructor would take two arguments: the object to be copied and a boolean to mark whether it should apply a deep or shallow copy.

    A drawback is that the copy constructor must check the incoming reference to see if it is not null. With the normal Prototype implementation, the method is certain to be called on a valid object.

  • clone method – The Java programming language already defines a clone method in the java.lang.Object class—the superclass of all Java classes. For the method to be usable on an instance, the class of that object has to implement the java.lang.Clonable interface to indicate that an instance of this class may be copied. Because the clone method is declared protected in Object, it has to be overridden to make it publicly available.

According to Bloch, "clone() should be used judiciously" [Bloch01]. As mentioned, a class has to implement Clonable, but that interface does not provide a guarantee that the object can be cloned. The Clonable interface does not defined the clone method, so it is possible that the clone method is not available when it is not overridden. Another drawback of the clone method is that it has a return type of Object, requiring you to cast it to the appropriate type before using it.

Related Patterns

Related patterns include the following:

  • Abstract Factory (page 6) – Abstract Factories can use the Prototype to create new objects based on the current use of the Factory.

  • Factory Method (page 21) – Factory Methods can use a Prototype to act as a template for new objects.

Example

NOTE

For a full working example of this code example, with additional supporting classes and/or a RunPattern class, see "Prototype" on page 357 of the "Full Code Examples" appendix.

The Address class in this example uses the Prototype pattern to create an address based on an existing entry. The core functionality for the pattern is defined in the interface Copyable.

Example 1.18 Copyable.java 0

1. public interface Copyable{
2.   public Object copy();
3. }

The Copyable interface defines a copy method and guarantees that any classes that implement the interface will define a copy operation. This example produces a shallow copy—that is, it copies the object references from the original address to the duplicate.

The code also demonstrates an important feature of the copy operation: not all fields must necessarily be duplicated. In this case, the address type is not copied to the new object. A user would manually specify a new address type from the PIM user interface.

Example 1.19 Address.java 0

 1. public class Address implements Copyable{
 2.   private String type;
 3.   private String street;
 4.   private String city;
 5.   private String state;
 6.   private String zipCode;
 7.   public static final String EOL_STRING =
 8.     System.getProperty("line.separator");
 9.   public static final String COMMA = ",";
10.   public static final String HOME = "home";
11.   public static final String WORK = "work";
12.   
13.   public Address(String initType, String initStreet,
14.     String initCity, String initState, String initZip){
15.       type = initType;
16.       street = initStreet;
17.       city = initCity;
18.       state = initState;
19.       zipCode = initZip;
20.   }
21.   
22.   public Address(String initStreet, String initCity,
23.     String initState, String initZip){
24.       this(WORK, initStreet, initCity, initState, initZip);
25.   }
26.   public Address(String initType){
27.     type = initType;
28.   }
29.   public Address(){ }
30.   
31.   public String getType(){ return type; }
32.   public String getStreet(){ return street; }
33.   public String getCity(){ return city; }
34.   public String getState(){ return state; }
35.   public String getZipCode(){ return zipCode; }
36.   
37.   public void setType(String newType){ type = newType; }
38.   public void setStreet(String newStreet){ street = newStreet; }
39.   public void setCity(String newCity){ city = newCity; }
40.   public void setState(String newState){ state = newState; }
41.   public void setZipCode(String newZip){ zipCode = newZip; }
42.   
43.   public Object copy(){
44.     return new Address(street, city, state, zipCode);
45.   }
46.   
47.   public String toString(){
48.     return "\t" + street + COMMA + " " + EOL_STRING +
49.       "\t" + city + COMMA + " " + state + " " + zipCode;
50.   }
51. }
  • + 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