Why does int num = Integer.getInteger(“123”) throw NullPointerException?

by

The Big Picture

There are two issues at play here:

  • Integer getInteger(String) doesn’t do what you think it does
    • It returns null in this case
  • the assignment from Integer to int causes auto-unboxing
    • Since the Integer is null, NullPointerException is thrown

To parse (String) "123" to (int) 123, you can use e.g. int Integer.parseInt(String).

References

Integer API references

On Integer.getInteger

Here’s what the documentation have to say about what this method does:

public static Integer getInteger(String nm): Determines the integer value of the system property with the specified name. If there is no property with the specified name, if the specified name is empty or null, or if the property does not have the correct numeric format, then null is returned.

In other words, this method has nothing to do with parsing a String to an int/Integer value, but rather, it has to do with System.getProperty method.

Admittedly this can be quite a surprise. It’s unfortunate that the library has surprises like this, but it does teach you a valuable lesson: always look up the documentation to confirm what a method does.

Coincindentally, a variation of this problem was featured in Return of the Puzzlers: Schlock and Awe (TS-5186), Josh Bloch and Neal Gafter’s 2009 JavaOne Technical Session presentation. Here’s the concluding slide:

The Moral

  • Strange and terrible methods lurk in libraries
    • Some have innocuous sounding names
  • If your code misbehaves
    • Make sure you’re calling the right methods
    • Read the library documentation
  • For API designers
    • Don’t violate the principle of least astonishment
    • Don’t violate the abstraction hierarchy
    • Don’t use similar names for wildly different behaviors

For completeness, there are also these methods that are analogous to Integer.getInteger:

Related questions

On autounboxing

The other issue, of course, is how the NullPointerException gets thrown. To focus on this issue, we can simplify the snippet as follows:

Integer someInteger = null;
int num = someInteger; // throws NullPointerException!!!

Here’s a quote from Effective Java 2nd Edition, Item 49: Prefer primitive types to boxed primitives:

In summary, use primitives in preference to boxed primitive whenever you have the choice. Primitive types are simpler and faster. If you must use boxed primitives, be careful! Autoboxing reduces the verbosity, but not the danger, of using boxed primitives. When your program compares two boxed primitives with the == operator, it does an identity comparison, which is almost certainly not what you want. When your program does mixed-type computations involving boxed and unboxed primitives, it does unboxing, and when your program does unboxing, it can throw NullPointerException. Finally, when your program boxes primitive values, it can result in costly and unnecessary object creations.

There are places where you have no choice but to use boxed primitives, e.g. generics, but otherwise you should seriously consider if a decision to use boxed primitives is justified.

Related questions

More Related Contents:

  1. How can I properly compare two Integers in Java?
  2. Returning null as an int permitted with ternary operator but not if statement
  3. Booleans, conditional operators and autoboxing
  4. Why does String.valueOf(null) throw a NullPointerException?
  5. NullPointerException through auto-boxing-behavior of Java ternary operator
  6. NullPointerException with autoboxing in ternary expression
  7. add a bigInteger value to a 2d array
  8. What is a NullPointerException, and how do I fix it?
  9. Why is my Spring @Autowired field null?
  10. NullPointerException accessing views in onCreate()
  11. Why is the Java date API (java.util.Date, .Calendar) such a mess?
  12. How to convert int[] into List in Java?
  13. “Integer number too large” error message for 600851475143
  14. Why doesn’t Java throw an Exception when dividing by 0.0?
  15. Convert an integer to an array of digits
  16. The range of int in Java
  17. What code does the compiler generate for autoboxing?
  18. Null Pointer Exception while using Java Compiler API
  19. JPA/Hibernate Static Metamodel Attributes not Populated — NullPointerException
  20. Java Arrays.asList on primitive array type produces unexpected List type [duplicate]
  21. Why cannot cast Integer to String in java?
  22. Why can I throw null in Java? [duplicate]
  23. Is Catching a Null Pointer Exception a Code Smell?
  24. Gracefully avoiding NullPointerException in Java
  25. Attempt to invoke virtual method ‘void android.widget.Button.setOnClickListener(android.view.View$OnClickListener)’ on a null object reference
  26. Is there a default type for numbers in Java
  27. Why doesn’t autoboxing overrule varargs when using method overloading in Java 7?
  28. Why does Java think that the product of all numbers from 10 to 99 is 0?
  29. How can I check if a value is of type Integer?
  30. int[] and Integer[] arrays – What is the difference?

Leave a Comment