Problem statement: How do you make any java class immutable?
- Class must be declared as final (So that child classes can’t be created)
- Data members in the class must be declared as final (So that we can’t change the value of it after object creation)
- A parameterized constructor
- Getter method for all the variables in it
- No setters(To not have option to change the value of the instance variable)
- When exposing methods which modify the state of the class, you must always return a new instance of the class.
- If the class holds a mutable object:
- Inside the constructor, make sure to use a clone copy of the passed argument and never set your mutable field to the real instance passed through constructor, this is to prevent the clients who pass the object from modifying it afterwards.
- Make sure to always return a clone copy of the field and never return the real object instance
1) Don’t provide “setter” methods — methods that modify fields or objects referred to by fields.
This principle says that for all mutable properties in your class, do not provide setter methods. Setter methods are meant to change the state of object and this is what we want to prevent here.
2) Make all fields final and private
This is another way to increase immutability. Fields declared private will not be accessible outside the class and making them final will ensure the even accidentally you can not change them.
3) Don’t allow subclasses to override methods
The simplest way to do this is to declare the class as final. Final classes in java can not be overridden.
4) Special attention when having mutable instance variables
Always remember that your instance variables will be either mutable or immutable. Identify them and return new objects with copied content for all mutable objects. Immutable variables can be returned safely without extra effort.
A more sophisticated approach is to make the constructor private and construct instances in factory methods.
- import java.util.Date;
-
- /**
- * Always remember that your instance variables will be either mutable or immutable.
- * Identify them and return new objects with copied content for all mutable objects.
- * Immutable variables can be returned safely without extra effort.
- * */
- public final class ImmutableClass
- {
-
- /**
- * Integer class is immutable as it does not provide any setter to change its content
- * */
- private final Integer immutableField1;
- /**
- * String class is immutable as it also does not provide setter to change its content
- * */
- private final String immutableField2;
- /**
- * Date class is mutable as it provide setters to change various date/time parts
- * */
- private final Date mutableField;
-
- //Default private constructor will ensure no unplanned construction of class
- private ImmutableClass(Integer fld1, String fld2, Date date)
- {
- this.immutableField1 = fld1;
- this.immutableField2 = fld2;
- this.mutableField = new Date(date.getTime());
- }
-
- //Factory method to store object creation logic in single place
- public static ImmutableClass createNewInstance(Integer fld1, String fld2, Date date)
- {
- return new ImmutableClass(fld1, fld2, date);
- }
-
- //Provide no setter methods
-
- /**
- * Integer class is immutable so we can return the instance variable as it is
- * */
- public Integer getImmutableField1() {
- return immutableField1;
- }
-
- /**
- * String class is also immutable so we can return the instance variable as it is
- * */
- public String getImmutableField2() {
- return immutableField2;
- }
-
- /**
- * Date class is mutable so we need a little care here.
- * We should not return the reference of original instance variable.
- * Instead a new Date object, with content copied to it, should be returned.
- * */
- public Date getMutableField() {
- return new Date(mutableField.getTime());
- }
-
- @Override
- public String toString() {
- return immutableField1 +" - "+ immutableField2 +" - "+ mutableField;
- }
- }
