Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why does the Double.valueof javadoc say it caches values, when it doesn't?

Tags:

java

javadoc

In OpenJDK, for the method:

public static Double valueOf(double d)

The javadoc says:

Returns a Double instance representing the specified double value. If a new Double instance is not required, this method should generally be used in preference to the constructor Double(double), as this method is likely to yield significantly better space and time performance by caching frequently requested values.

Here's the actual code:

public static Double valueOf(double d) {
    return new Double(d);
}

The cache is a lie! What's going on here?

like image 878
z7sg Ѫ Avatar asked Dec 19 '11 12:12

z7sg Ѫ


2 Answers

The method exists for many types: Integer, Long, BigDecimal and others and the documentation is always the same: Under some circumstances (which aren't defined), the method can return the same result.

AFAIK, the caching is only implemented for integer types and it returns cached instances for values between -128 and 127 (most common values). For BigDecimal, the cache currently works for values from 0 to 10.

Later versions of Java might extend this behavior to other values/more types. So it's smart to use this code today because it might make your code faster tomorrow (and the code won't be slower today).

The Java compiler, for example, uses this API when generating code for autoboxing.

like image 129
Aaron Digulla Avatar answered Nov 08 '22 15:11

Aaron Digulla


There is nothing wrong with the API doc:

This method is likely to yield...

That is, an implementation is allowed to do caching here, which is simply not possible with a constructor. However, it is not required to. But, since chances are that you have an implementation that performs caching, this method should be preferred over using a constructor.

like image 30
scravy Avatar answered Nov 08 '22 15:11

scravy