Page History

Java defines the equality operators == and != for testing reference equality , but uses the Object.equals() method defined in Object and its children subclasses for testing abstract object equality. Naive Naïve programmers often confuse the intent of the == operation with that of the Object.equals() method. This confusion is frequently seen evident in the context of processing String processing objects.

As a general rule, use the Object.equals() method to check whether two objects are abstractly equal to each other. Reserve use of have equivalent contents and use the equality operators == and != for testing to test whether two references specifically refer to the same object (this is reference equality). See also guideline MET13. This latter test is referred to as referential equality. For classes that require overriding the default equals() implementation, care must be taken to also override the hashCode() method (see MET09-J. Classes that define an equals() method must also define a hashCode() method).

This also applies to numeric Numeric boxed types (for example, Byte, Character, Short, Integer, Long, Float, and Double) should also be compared using Object.equals(), although the numeric relational operators rather than the == operator. While reference equality may appear to work for Integer values between the range −128 and 127, it may fail if either of the operands in the comparison are outside that range. Numeric relational operators other than equality (such as <, <=, >, and >=) produce results that match those provided for arguments of the equivalent primitive numeric types. See guideline can be safely used to compare boxed primitive types (see  EXP03-J. Avoid Do not use the equality operators when comparing values of boxed primitives for more information).

Noncompliant Code Example

The reference equality operator == evaluates to true only when the values it compares reference the same underlying object. This noncompliant code example declares two distinct String objects that contain the same value. The references, however, are unequal because they reference distinct objects.:

public class ExampleComparisonStringComparison {
  public static void main(String[] args) {
    String str1 = new String("one");
    String str2 = new String("one");
    boolean result;
    // test below is redundant in this case, but required for full generality
    if (str1 == null) { 
      result = str2 == null;
    }
    else {
      result = System.out.println(str1 == str2;
    }
    System.out.println(result); // printsPrints "false"
  }
}

The reference equality operator == evaluates to true only when the values it compares refer to the same underlying object. The references in this example are unequal because they refer to distinct objects.

Compliant Solution (Object.equals())

This compliant solution uses the Object.equals() method when comparing string values.:

public class GoodComparisonStringComparison {
  public static void main(String[] args) {
    String str1 = new String("one");
    String str2 = new String("one");
    boolean result;
    if (str1 == null) {
      result = (str2 == null);
    } else {
      result = str1.equals(str2);
    }
    System.out.println(result);System.out.println(str1.equals( str2)); // Prints "true"
  }
}

Compliant Solution (String.intern())

Reference equality behaves like abstract object equality when comparing it is used to compare two strings that are each the result results of the String.intern() method. When a task requires keeping . This compliant solution uses String.intern() and can perform fast string comparisons when only one copy of each string in memory, as well as performing quick repeated string comparisons, this compliant solution may be usedthe string one is required in memory.

public class GoodComparisonStringComparison {
  public static void main(String[] args) {
    String str1 = new String("one");
    String str2 = new String("one");
    boolean result;
    if (str1 != null) {
      str1 = str1.intern();
    }
    if (str2 != null) {
      str2 = str2.intern();
    }
    result = System.out.println(str1 == str2);

 //  System.out.println(result);Prints "true"
  }
}

Use this approach with care; performance and clarity could be better served by of String.intern() should be reserved for cases in which the tokenization of strings either yields an important performance enhancement or dramatically simplifies code. Examples include programs engaged in natural language processing and compiler-like tools that tokenize program input. For most other programs, performance and readability are often improved by the use of code that applies the Object.equals() approach and that lacks any dependence on reference equality.

Exceptions

.

The Java Language Specification (JLS) [JLS 2013] provides very limited guarantees about the implementation of String.intern(). For example,

• The cost of String.intern() grows as the number of intern strings grows. Performance should be no worse than O(n log n), but the JLS lacks a specific performance guarantee.
• In early Java Virtual Machine (JVM) implementations, interned strings became immortal: they were exempt from garbage collection. This can be problematic when large numbers of strings are interned. More recent implementations can garbage-collect the storage occupied by interned strings that are no longer referenced. However, the JLS lacks any specification of this behavior.
• In JVM implementations prior to Java 1.7, interned strings are allocated in the permgen storage region, which is typically much smaller than the rest of the heap. Consequently, interning large numbers of strings can lead to an out-of-memory condition. In many Java 1.7 implementations, interned strings are allocated on the heap, relieving this restriction. Once again, the details of allocation are unspecified by the JLS; consequently, implementations may vary.

String interning may also be used in programs that accept repetitively occurring strings. Its use boosts the performance of comparisons and minimizes memory consumption.

When canonicalization of objects is required, it may be wiser to use a custom canonicalizer built on top of ConcurrentHashMap; see Joshua Bloch's Effective Java, second edition, Item 69 [Bloch 2008], for details.

Applicability

Confusing reference equality and object equality can lead to unexpected results.

Using EXP01-EX1: Use of reference equality in place of object equality is permitted only when the defining classes guarantee the existence of, of at most , one object instance for each possible object value. This generally requires that instances of such classes are immutable. The use of static factory methods, rather than public constructors, facilitates instance control; this is a key enabling technique.

Objects that are instances of classes that provide this guarantee obey the invariant that, for any two references {{a}} and {{b}}, {{a.equals(b)}} is exactly equivalent to {{a == b}} \[[Bloch 2008|AA. Bibliography#Bloch 08]\]. The {{String}} class does not meet these requirements and consequently does not obey this invariant.

Another technique is to use an enum type.

EXP01-EX2: Use reference equality to determine whether two references point to the same object.

Risk Assessment

Using reference equality to compare objects may lead to unexpected results.

Automated Detection

The Coverity Prevent Version 5.0 BAD_EQ checker can detect the instance where the "==" operator is being used for equality of objects when, ideally, the equal method should have been used. The "==" operator could consider objects different when the equals method considers them the same.

Findbugs checks this guideline for type String.

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this guideline on the CERT website.

Related Guidelines

MITRE CWE: CWE-595 "Incorrect Syntactic Object Comparison"

MITRE CWE: CWE-597 "Use of Wrong Operator in String Comparison"

Bibliography

\[[FindBugs 2008|AA. Bibliography#FindBugs 08]\] ES: Comparison of String objects using == or \!=
\[[JLS 2005|AA. Bibliography#JLS 05]\] [Section 3.10.5|http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.10.5], "String Literals" and [Section 5.6.2|http://java.sun.com/docs/books/jls/third_edition/html/conversions.html#5.6.2], "Binary Numeric Promotion"

Automated Detection

Bibliography

...

Image Added Image Added Image AddedImage Removed      04. Expressions (EXP)      EXP02-J. Use the two-argument Arrays.equals() method to compare the contents of arrays