How to clone a Java object with the clone() method

clone, java

Solution

The clone method is meant to make a deep copy. Make sure you understand the difference between deep and shallow copies. In your case a copy constructor may be the pattern you want. In some cases you can't use this pattern however, for example because you're subclassing class X and you don't have access to the constructor of X that you need. If X overrides its clone method correctly (if necessary) then you could make a copy in the following way:

class Y extends X implements Cloneable {

    private SomeType field;    // a field that needs copying in order to get a deep copy of a Y object

    ...

    @Override
    public Y clone() {
        final Y clone;
        try {
            clone = (Y) super.clone();
        }
        catch (CloneNotSupportedException ex) {
            throw new RuntimeException("superclass messed up", ex);
        }
        clone.field = this.field.clone();
        return clone;
    }

}

In general when overriding your clone method:

- Make the return type more specific

- Start with calling `super.clone()`

- Do not include throws clause when you know `clone()` will also work for any subclass (weakness of the clone-pattern; make class final if possible)

- Leave immutable and primitive fields alone, but clone mutable object fields manually after the call to `super.clone()` (another weakness of the clone-pattern, since these fields cannot be made final)

The `clone()` method of `Object` (which will eventually be called when all superclasses obey the contract) makes a shallow copy and takes care of the correct runtime type of the new object. Note how no constructor is called in the entire process.

If you want to be able to call `clone()` on instances, then implement the `Cloneable` interface and make the method public. If you don't want to be able to call it on instances, but you do want to make sure subclasses can call their `super.clone()` and get what they need, then don't implement `Cloneable` and keep the method `protected` if your superclass hasn't declared it public already.

The clone pattern is difficult and has a lot of pitfalls. Be sure it's what you need. Consider copy constructors, or a static factory method.

Problem

I don't understand the mechanism of cloning custom object. For example: ``` public class Main{ public static void main(String [] args) { Person person = new Person(); person.setFname("Bill"); person.setLname("Hook"); Person cloned = (Person)person.clone(); System.out.println(cloned.getFname() + " " + cloned.getLname()); } } class Person implements Cloneable{ private String fname; private String lname; public Object clone() { Person person = new Person(); person.setFname(this.fname); person.setLname(this.lname); return person; } public void setFname(String fname) { this.fname = fname; } public void setLname(String lname){ this.lname = lname; } public String getFname(){ return fname; } public String getLname() { return lname; } } ``` This is example shows right way of cloning as a in the books write. But I can delete implements Cloneable in the class name definition and I receive the same result. So I don't understand the proposing of Cloneable and why clone() method is defined in class Object?

Original source

Related problems