Why can final object be modified?

JavaFinal

Java Problem Overview


I came across the following code in a code base I am working on:

public final class ConfigurationService {
    private static final ConfigurationService INSTANCE = new ConfigurationService();
    private List providers;

    private ConfigurationService() {
        providers = new ArrayList();
    }

    public static void addProvider(ConfigurationProvider provider) {
        INSTANCE.providers.add(provider);
    }

    ...

INSTANCE is declared as final. Why can objects be added to INSTANCE? Shouldn't that invalidate the use of final. (It doesn't).

I'm assuming the answer has to do something with pointers and memory but would like to know for sure.

Java Solutions


Solution 1 - Java

final simply makes the object reference unchangeable. The object it points to is not immutable by doing this. INSTANCE can never refer to another object, but the object it refers to may change state.

Solution 2 - Java

Being final is not the same as being immutable.

final != immutable

The final keyword is used to make sure the reference is not changed ( that is, the reference it has can't be substituted with a new one )

But, if the attribute is self is modifiable it is ok to do what you have just described.

For instance

class SomeHighLevelClass {
    public final MutableObject someFinalObject = new MutableObject();
}

If we instantiate this class, we won't be able to assign other value to the the attribute someFinalObject because it is final.

So this is not possible:

....
SomeHighLevelClass someObject = new SomeHighLevelClass();
MutableObject impostor  = new MutableObject();
someObject.someFinal = impostor; // not allowed because someFinal is .. well final

But if the object it self is mutable like this:

class MutableObject {
     private int n = 0;

     public void incrementNumber() {
         n++;
     }
     public String toString(){
         return ""+n;
     }
}  

Then, the value contained by that mutable object may be changed.

SomeHighLevelClass someObject = new SomeHighLevelClass();

someObject.someFinal.incrementNumber();
someObject.someFinal.incrementNumber();
someObject.someFinal.incrementNumber();

System.out.println( someObject.someFinal ); // prints 3

This has the same effect that your post:

public static void addProvider(ConfigurationProvider provider) {
    INSTANCE.providers.add(provider);
}

Here you are not changing the value of INSTANCE, your are modifying its internal state ( via, providers.add method )

if you want to prevent that the class definition should be changed like this:

public final class ConfigurationService {
    private static final ConfigurationService INSTANCE = new ConfigurationService();
    private List providers;

    private ConfigurationService() {
        providers = new ArrayList();
    }
    // Avoid modifications      
    //public static void addProvider(ConfigurationProvider provider) {
    //    INSTANCE.providers.add(provider);
    //}
    // No mutators allowed anymore :) 
....

But, it might not make much sense :)

By the way, you also have to synchronize access to it basically for the same reason.

Solution 3 - Java

The key to the misunderstanding is in your question's title. It's not the object which is final, it's the variable. The variable's value can't change, but the data within it can.

Always remember that when you declare a reference type variable, the value of that variable is a reference, not an object.

Solution 4 - Java

final just means the reference can't be changed. You can't reassign INSTANCE to another reference if it's declared as final. The internal state of the object is still mutable.

final ConfigurationService INSTANCE = new ConfigurationService();
ConfigurationService anotherInstance = new ConfigurationService();
INSTANCE = anotherInstance;

would throw a compilation error

Solution 5 - Java

> Once a final variable has been assigned, it always contains the same value. If a final variable holds a reference to an object, then the state of the object may be changed by operations on the object, but the variable will always refer to the same object. This applies also to arrays, because arrays are objects; if a final variable holds a reference to an array, then the components of the array may be changed by operations on the array, but the variable will always refer to the same array.

Source

Here's a guide on making an object immutable.

Solution 6 - Java

Final and immutable are not the same thing. Final means the reference cannot be reassigned so you can't say

INSTANCE = ...

Immutable means that the object itself cannot be modified. An example of this is the java.lang.String class. You cannot modify the value of a string.

Solution 7 - Java

Java doesn't have the concept of immutability built into the language. There is no way to mark methods as a mutator. Therefore the language has no way to enforce object immutability.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionMatt McCormickView Question on Stackoverflow
Solution 1 - JavaSean OwenView Answer on Stackoverflow
Solution 2 - JavaOscarRyzView Answer on Stackoverflow
Solution 3 - JavaJon SkeetView Answer on Stackoverflow
Solution 4 - JavaTheoView Answer on Stackoverflow
Solution 5 - JavadefectivehaltView Answer on Stackoverflow
Solution 6 - JavaChris DailView Answer on Stackoverflow
Solution 7 - JavaSteve KuoView Answer on Stackoverflow