What are Null Pointer Exceptions (java.lang.NullPointerException
) and what causes them?
What methods/tools can be used to determine the cause so that you stop the exception from causing the program to terminate prematurely?
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
When you declare a reference variable (i.e., an object), you are really creating a pointer to an object. Consider the following code where you declare a variable of primitive type
int
:In this example, the variable
x
is anint
and Java will initialize it to0
for you. When you assign the value of10
on the second line, your value of10
is written into the memory location referred to byx
.But, when you try to declare a reference type, something different happens. Take the following code:
The first line declares a variable named
num
, but it does not actually contain a primitive value yet. Instead, it contains a pointer (because the type isInteger
which is a reference type). Since you have not yet said what to point to, Java sets it tonull
, which means “I am pointing to nothing“.In the second line, the
new
keyword is used to instantiate (or create) an object of typeInteger
, and the pointer variablenum
is assigned to thatInteger
object.The
NullPointerException
(NPE) occurs when you declare a variable but did not create an object and assign it to the variable before trying to use the contents of the variable (called dereferencing). So you are pointing to something that does not actually exist.Dereferencing usually happens when using
.
to access a method or field, or using[
to index an array.If you attempt to dereference
num
before creating the object you get aNullPointerException
. In the most trivial cases, the compiler will catch the problem and let you know that “num may not have been initialized
,” but sometimes you may write code that does not directly create the object.For instance, you may have a method as follows:
In which case, you are not creating the object
obj
, but rather assuming that it was created before thedoSomething()
method was called. Note, it is possible to call the method like this:In which case,
obj
isnull
, and the statementobj.myMethod()
will throw aNullPointerException
.If the method is intended to do something to the passed-in object as the above method does, it is appropriate to throw the
NullPointerException
because it’s a programmer error and the programmer will need that information for debugging purposes.In addition to
NullPointerException
s thrown as a result of the method’s logic, you can also check the method arguments fornull
values and throw NPEs explicitly by adding something like the following near the beginning of a method:Note that it’s helpful to say in your error message clearly which object cannot be
null
. The advantage of validating this is that 1) you can return your own clearer error messages and 2) for the rest of the method you know that unlessobj
is reassigned, it is not null and can be dereferenced safely.Alternatively, there may be cases where the purpose of the method is not solely to operate on the passed in object, and therefore a null parameter may be acceptable. In this case, you would need to check for a null parameter and behave differently. You should also explain this in the documentation. For example,
doSomething()
could be written as:Finally, How to pinpoint the exception & cause using Stack Trace
Sonar with find bugs can detect NPE. Can sonar catch null pointer exceptions caused by JVM Dynamically
Now Java 14 has added a new language feature to show the root cause of NullPointerException. This language feature has been part of SAP commercial JVM since 2006.
In Java 14, the following is a sample NullPointerException Exception message:
NullPointerException
s are exceptions that occur when you try to use a reference that points to no location in memory (null) as though it were referencing an object. Calling a method on a null reference or trying to access a field of a null reference will trigger aNullPointerException
. These are the most common, but other ways are listed on theNullPointerException
javadoc page.Probably the quickest example code I could come up with to illustrate a
NullPointerException
would be:On the first line inside
main
, I’m explicitly setting theObject
referenceobj
equal tonull
. This means I have a reference, but it isn’t pointing to any object. After that, I try to treat the reference as though it points to an object by calling a method on it. This results in aNullPointerException
because there is no code to execute in the location that the reference is pointing.(This is a technicality, but I think it bears mentioning: A reference that points to null isn’t the same as a C pointer that points to an invalid memory location. A null pointer is literally not pointing anywhere, which is subtly different than pointing to a location that happens to be invalid.)