Does Making All Fields Finally Makes The Bird Immutable Inwards Java?

One of the mutual misconceptions alongside many Java Programmer is that a bird with all concluding fields automatically becomes Immutable. This is non correct, you lot tin post away easily pause immutability of certainly bird if the concluding champaign it contains is a mutable one, every bit we'll come across inwards this article. One of the well-nigh mutual examples of this is a java.util.Date fields e.g. birthDay, expirtyDate, or joiningDate sort of fields. You induce got to hold upward extra cautious to dice along your class' immutability intact with mutable fields. The well-nigh mutual error inwards this regard happens when Java programmer render reference of the master object when a customer enquire e.g. getBirthDay() returns the appointment object pointed past times birthDay field. When you lot render a reference to a mutable object, you lot are sharing ownership of that reference with whoever receives it. This tin post away pause invariant, such every bit immutability.

Another instance of this variety of pattern which tin post away pause immutability is returning collection or array from the getters method e.g. getListOfBooks() returns a listing of books. Once clients acquire that listing it tin post away add together novel books, take away books as well as fifty-fifty modify employees without consulting you, thus bypassing whatever rules you lot induce got setup to add together or take away books from that list.

So, fifty-fifty though, the champaign which is pointing to Date or Collection or array object is final, you lot tin post away withal pause the immutability of the bird past times breaking Encapsulation past times returning a reference to the master mutable object.

How to save Immutability?

There are 2 ways to avoid this problem, first, don't render getters to mutable objects if you lot tin post away avoid it. If you lot must, as well as so visit returning a re-create or clone of the mutable object. If you lot are returning a collection, you lot could roll it every bit an unmodifiable collection. Since nosotros cannot brand an array concluding or unmodifiable inwards Java, I advise avoiding returning an array, instead render an ArrayList past times converting an array to ArrayList every bit shown here.

Now, let's come across to a greater extent than or less code to empathize this error inwards lilliputian combat to a greater extent than especial as well as and so we'll come across the right code to solve this work past times preserving both Encapsulation as well as Immutability of class.

I induce got a unproblematic POJO called Person which has iii fields, mention which is String, birthday which is Date, as well as hobbies which are inwards a listing of String. All these fields are final, only I'll demo you lot how you lot tin post away withal pause the immutability of Person bird past times returning a reference to the mutable object to the client.

Remember, an Immutable object cannot hold upward changed in i lawsuit created, thus it's value volition ever hold upward same as well as whatever modification on an Immutable object should render a novel Immutable object e.g. String is Immutable as well as when you lot telephone telephone toUpperCase() or toLowerCase() or trim() you lot acquire a novel String object.

Here is our Java Program to demonstrate that concluding fields are non plenty to brand a bird Immutable inwards Java:

import java.util.ArrayList; import java.util.Calendar; import java.util.Date; import java.util.List;  /**  * Java Program to demonstrate that making all  * fields concluding doesn't brand a bird Immutable.  * You tin post away withal pause immutability if you lot render  * reference to mutable objects to client.  *   * @author WINDOWS 8  *  */ public class App {      public static void main(String args[]) {      Calendar cal = Calendar.getInstance();      cal.set(1982, 4, 21);      Date birthDate = cal.getTime();            List hobbies = new ArrayList<>();           hobbies.add("Painting");      hobbies.add("Travelling");      hobbies.add("Fitness");           Person robin = new Person("Robin", birthDate, hobbies);      System.out.println("Before");      System.out.println(robin);            // if it's immutable you lot can't alter the object      Date birthday = robin.getBirthday();      birthday.setTime(System.currentTimeMillis());            List originalHobbies = robin.getHobbies();      originalHobbies.remove(0);      originalHobbies.remove(0);            System.out.println("After");      System.out.println(robin);         }  }  class Person{   private final String name;   private final Date birthday;   private final List hobbies;         public Person(String name, Date birthday, List hobbies){     this.name = name;     this.birthday = birthday;     this.hobbies = hobbies;   }   public String getName() {     return name;   }   public Date getBirthday() {     return birthday;   }   public List getHobbies() {     return hobbies;   }      @Override   public String toString() {     return "Person [name=" + mention + ", birthday=" + birthday + ", hobbies="         + hobbies + "]";   }          }

When you lot run this computer program inwards your IDE or from the ascendency line, you lot volition come across next output:

Before Person [name=Robin, birthday=Fri May 21 10:51:13 GMT+08:00 1982,  hobbies=[Painting, Travelling, Fitness]] Person [name=Robin, birthday=Sun April 09 10:51:13 GMT+08:00 2017,  hobbies=[Fitness]] After

You tin post away come across that nosotros induce got managed to alter the country of Person object past times changing its birthdate as well as hobbies. This way the Person bird is non Immutable fifty-fifty its all fields are final.  Now, let's come across how nosotros tin post away solve this problem. If you lot remember, String is Immutable inwards Java as well as you lot cannot alter its content later creating it.

In gild to save immutability, nosotros demand to render a clone of the mutable Date object as well as an unmodifiable ArrayList when the customer asks for hobbies.

Here is the modified code:

class Person{   private final String name;   private final Date birthday;   private final List hobbies;         public Person(String name, Date birthday, List hobbies){     this.name = name;     this.birthday = birthday;     this.hobbies = hobbies;   }   public String getName() {     return name;   }   public Date getBirthday() {     return (Date) birthday.clone();   }   public List getHobbies() {     return Collections.unmodifiableList(hobbies);   }      @Override   public String toString() {     return "Person [name=" + mention + ", birthday=" + birthday + ", hobbies="         + hobbies + "]";   }

You tin post away come across that inwards the getBirthDay() method, I am returning a clone of Date object as well as inwards the getHobbies() method, I am returning as well as unmodifiable collection, which way if a user tries to add together to a greater extent than or less other hobby it volition fail.

In Java, Strings are immutable only well-nigh objects are not. Whenever you lot induce got a mutator or setter method e.g. setXXX or addXXX that returns void chances are practiced that the object is mutable. Some of the mutual examples are ArrayList as well as LinkedList.

To brand you lot objects immutable brand certainly they exclusively induce got concluding fields that are non arrays (arrays are ever mutable inwards java) as well as exclusively render clone or re-create of the mutable object from getter method if you lot induce got to, best is to avoid returning references of mutable object altogether.

That's all inwards this article if you lot are interested inwards learning essence Java concepts similar this, I advise you lot read Effective Java, i of the best mass for every experienced Java programmers.

Further Learning
Complete Java Masterclass
Java Fundamentals: The Java Language
Java In-Depth: Become a Complete Java Engineer!