Prototype Design Pattern

14/07/2010

When creating an object is time consuming and a costly affair and you already have a most similar object instance in hand, then you go for prototype pattern. Instead of going through a time consuming process to create a complex object, just copy the existing similar object and modify it according to your needs.

Its a simple and straight forward design pattern. Nothing much hidden beneath it. If you don’t have much experience with enterprise grade huge application, you may not have experience in creating a complex / time consuming instance. All you might have done is use the new operator or inject and instantiate.

If you are a beginner you might be wondering, why all the fuss about prototye design pattern and do we really need this design pattern? Just ignore, all the big guys requires it. For you, just understand the pattern and sleep over it. You may require it one day in future.

Prototype pattern may look similar to builder design pattern. There is a huge difference to it. If you remember, “the same construction process can create different representations” is the key in builder pattern. But not in the case of prototype pattern.

So, how to implement the prototype design pattern? You just have to copy the existing instance in hand. When you say copy in java, immediately cloning comes into picture. Thats why when you read about prototype pattern, all the literature invariably refers java cloning.

Simple way is, clone the existing instance in hand and then make the required update to the cloned instance so that you will get the object you need. Other way is, tweak the cloning method itself to suit your new object creation need. Therefore whenever you clone that object you will directly get the new object of desire without modifying the created object explicitly.

The prototype design pattern mandates that the instance which you are going to copy should provide the copying feature. It should not be done by an external utility or provider.

But the above, other way comes with a caution. If somebody who is not aware of your tweaking the clone business logic uses it, he will be in issue. Since what he has in hand is not the exact clone. You can go for a custom method which calls the clone internally and then modifies it according to the need. Which will be a better approach.

Always remember while using clone to copy, whether you need a shallow copy or deep copy. Decide based on your business needs. If you need a deep copy, you can use serialization as a hack to get the deep copy done. Using clone to copy is entirey a design decision while implementing the prototype design pattern. Clone is not a mandatory choice for prototype pattern.

In prototype pattern, you should always make sure that you are well knowledgeable about the data of the object that is to be cloned. Also make sure that instance allows you to make changes to the data. If not, after cloning you will not be able to make required changes to get the new required object.

Following sample java source code demonstrates the prototype pattern. I have a basic bike in hand with four gears. When I want to make a different object, an advance bike with six gears I copy the existing instance. Then make necessary modifications to the copied instance. Thus the prototype pattern is implemented. Example source code is just to demonstrate the design pattern, please don’t read too much out of it. I wanted to make things as simple as possible.

Sample Java Source Code for Prototype Design Pattern

package com.javapapers.sample.designpattern.prototype;

class Bike implements Cloneable {
	private int gears;
	private String bikeType;
	private String model;
	public Bike() {
		bikeType = "Standard";
		model = "Leopard";
		gears = 4;
	}

	public Bike clone() {
		return new Bike();
	}

	public void makeAdvanced() {
		bikeType = "Advanced";
		model = "Jaguar";
		gears = 6;
	}
	public String getModel(){
		return model;
	}
}

public class Workshop {
	public Bike makeJaguar(Bike basicBike) {
		basicBike.makeAdvanced();
		return basicBike;
	}
	public static void main(String args[]){
		Bike bike = new Bike();
		Bike basicBike = bike.clone();
		Workshop workShop = new Workshop();
		Bike advancedBike = workShop.makeJaguar(basicBike);
		System.out.println("Prototype Design Pattern: "+advancedBike.getModel());
	}
}

Nice post

gift vincy on July 15th, 2010 7:31 am

public  Bike clone() {
  return new Bike();
}

Using new operator for cloning is wrong pattern to use. Even though for the sake of current need it works fine, we should never use new operator in clone method instead you should use super.clone() and typecast it to Bike.

- Pa1

Pa1 on July 28th, 2010 2:06 pm

I was thinking the same, where’s the advantage of cloning over new since you use new in the clone() method? :)

Laurentiu on September 22nd, 2010 3:10 pm

This example is actually wrong. If you use “NEW” operator you just simply create new Object of the same type and of course you can change its characteristics without problems :).

Leon on September 27th, 2010 12:18 pm

I agree, super.clone() is the correct way to create cloned object..now new***

Pawan on September 28th, 2010 1:17 pm

“class Bike implements Cloneable”

Where is definition of “Cloneable” in this example?

AlexRezn on November 11th, 2010 4:53 pm

can u pls explain more design patterns.

Joseph on March 23rd, 2011 7:35 am

Xellent….. :)Help me preparing lab viva…

Murtaza on May 4th, 2011 5:05 am

Thanks, it was good article. :)

Kinshuk on May 29th, 2011 6:16 am

Replace:
public Bike clone() {
return new Bike();
}

WITH:
public Bike clone() {
//return new Bike();
Bike byk=null;
try{
byk=(Bike)super.clone();
}
catch(CloneNotSupportedException e)
{
System.out.println(e.getMessage());
}
return byk;
}

ziana on October 26th, 2011 2:39 pm

It’s very useful , kindly explain more patterns.

Snehal on October 27th, 2011 7:10 am

Thank you!!! Good article.

João Carrihlo on November 19th, 2011 3:15 pm

super.clone calls the objects class clone method then we ouself doncasting it to the Bike type i think its best way to use protype design pattern.

deependra on December 16th, 2011 6:35 am

Good blog

Balamurali on February 10th, 2012 3:00 pm

It is indeed a good blog

sir on March 5th, 2012 9:28 pm

I like your explanation,Thanks for your effort.

PL on March 13th, 2012 11:34 am

Where is this used ? any example scenarios or incase used in java api?

Thanks!

daedlus on March 20th, 2012 11:14 pm

yes you have to use shallow copy or deep copy for cloning

pavan k on March 26th, 2012 11:51 am

Hey Joe, I guess all the above discussion over using new operator to clone is because people not understanding that you tried using deep cloning. If I understand correctly when you did
public Bike clone() {
/* This is deep clone of Bike Object*/
return new Bike();
}

but if you call super.clone then only shallow cloning takes place.

Its purely a design choice..I doubt anything wrong here

Amit

Amit Shrivastava on March 28th, 2012 10:50 am

I didn’t get this idea..So if you don’t have much time to create new object then how you will manage time by writing workshop class? and also you are just changing the value of the properties and not the actual object? Also you have a authority to modify already written class(for making object). Because in some big org you cant not just modify code of your super classes of framework.?

Chetan on March 30th, 2012 12:15 pm

thank u !!
i learned alot from this
good work

fahim javed on April 28th, 2012 1:09 pm


Email:

about
I am Joe, author of this blog. I run this with loads of passion. If you are into java, you may find lot of interesting things around ...more about me. Google+
java badge
Home