Don’t be strung along

The String class’s strange behavior explained

September 6, 2002

Q: I’ve received quite a collection of string questions in my JavaWorld Java Q&A mailbox. Here is just a sampling:

  1. “If I create two strings the following way:

       String string1 = "hello world";
        String string2 = new String("hello world");
    
    

    then string1 and string2 will have the same hash code. Does that mean that they are actually the same object in the JVM?”

  2. “In Java, if I create a String object, I can compare it to other String objects using the equals() method. However, if I initialize a String like this:

    String str="hello"
    
    

    and another like this:

    String s="hello"
    
    

    then I can compare them using the == sign. Why?”

  3. “If I code this:

    a = "hello"
    b = "hello"
    c = new string("hello")
    d = "hello"
    
    

    a and b both refer to the same "hello" String object in memory, whereas c refers to a separate "hello" String object that exists concurrently with the first "hello" String object. Therefore, two "hello" objects exist in memory. Which of the two "hello" objects will d refer to? How is it decided?”

A:

Let’s examine each question in turn.

Question 1: Are they the same object?

You are correct: both objects will have the same hash code. As stated in the Javadocs, the string’s hash code is computed according to the following formula:

s[0]*31^(n-1) + s[1]*31^(n-2) + … + s[n-1] using int arithmetic, where s[i] is the ith character of the string, n is the length of the string, and ^ indicates exponentiation. (The hash value of the empty string is zero.)

Since both strings have the same character sequence, the hashcode() methods will compute the same value. That being said, string1 and string2 do not point to the same object. They point to different objects! The call String string1 = "hello world"; results in the allocation of one String object: "hello world". Explicitly calling new in String string2 = new String("hello world"); forces the creation of a second String object in memory: "hello world".

String allocation, like all object allocation, proves costly in both time and memory. To cut down the number of String objects created in the JVM, the String class keeps a pool of strings. Each time you create a string literal, the pool is checked. If the string already exists in the pool, a reference to the pooled instance returns. If the string does not exist in the pool, a new String object instantiates, then is placed in the pool. Java can make this optimization since strings are immutable and can be shared without fear of data corruption.

Unfortunately, creating a string through new defeats this pooling mechanism by creating multiple String objects, even if an equal string already exists in the pool. Considering all that, avoid new String unless you specifically know that you need it!

Question 2: Why can we use equals() and == on strings?

The answer to Question 2 directly relates to the answer to Question 1. Because string literals are pooled, the following code causes the JVM to create just one String object:

 
String str="hello"; 
String s="hello"

Thus, the reference pointed to by str and s is actually the same. Therefore, == returns the correct result. However, relying on == for string equality checking is unsafe. Let’s say someone says String tricky = new String("hello"). In that case, the JVM will not check whether a "hello" string object already exists. Instead, the JVM will blindly allocate another string in memory. The new call forces the JVM to create a new object. If you say tricky == s, the expression will return false, since tricky and s are not references to the same object.

Remember, use == to check whether two references refer to the same object. Use equals() to check whether the contents of two objects are equal. Do not assume that == will always work for testing strings!

Question 3: How is it decided?

As for Question 3, in the case of d = "hello", d points to the same reference as that pointed to by both a and b. Before the JVM creates a string literal, the JVM checks the string literal pool first. Since "hello" already exists in that pool, d will simply be set to point to that pooled instance.

String wrap up

All three questions are related because the JVM performs some trickery while instantiating string literals to increase performance and decrease memory overhead. The JVM can reuse and share string references because strings are immutable and, therefore, by definition thread-safe. That’s a nice design; although a design you must be aware of and treat accordingly.

Tony Sintes is an independent consultant and founder of First Class Consulting, Inc., a consulting firm that specializes in bridging disparate enterprise systems and training. Outside of First Class Consulting, Tony is an active freelance writer, as well as author of Sams Teach Yourself Object-Oriented Programming in 21 Days (Sams, 2001; ISBN: 0672321092).

Source: www.infoworld.com