When to use intern() on String literals
I see a lot of legacy code like this:
class A {
public static final String CONSTANT = "value".intern();
...
}
I don't see any reason for the intern(), as in the Javadoc one can read: "All literal strings and string-valued constant expressions are interned." Is there some intent of this, maybe in past revisions of the language?
This is a technique to ensure that CONSTANT
is not actually a constant.
When the Java compiler sees a reference to a final static primitive or String, it inserts the actual value of that constant into the class that uses it. If you then change the constant value in the defining class but don't recompile the using class, it will continue to use the old value.
By calling intern() on the "constant" string, it is no longer considered a static constant by the compiler, so the using class will actually access the defining class' member on each use.
JLS citations:
definition of a compile-time constant: http://docs.oracle.com/javase/specs/jls/se6/html/expressions.html#5313
implication of changes to a compile-time constant (about halfway down the page): http://docs.oracle.com/javase/specs/jls/se6/html/binaryComp.html#45139
The use of intern()
with the constant string literal is a waste of time as the literal will already be interned as specified by section 3.10.5. String Literals of The Java® Language Specification.
Quoting from Java SE 8 Edition:
Moreover, a string literal always refers to the same instance of class String. This is because string literals - or, more generally, strings that are the values of constant expressions (§15.28) - are "interned" so as to share unique instances, using the method String.intern.
I guess the coder didn't appreciate this fact.
Edit:
As kdgregory has pointed out there is an impact on how this constant may be inlined.
1- https://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.10.5