Use
stringVariable == null
To test whether stringVariable is null.
The equals method (and every other method) requires stringVariable to not be null.
Use
stringVariable == null
To test whether stringVariable is null.
The equals method (and every other method) requires stringVariable to not be null.
if stringvariableis already null, it doesn't exist as a String object anymore, so it won't even have a .equals method! So in the event when stringvariable is null, what you are really doing is null.equals(null), at which point you'll get the NullPointerException because null doesn't have a .equals() method.
Using "abc".equals(...) is a reasonable precaution against a condition you didn't anticipate, but doesn't really solve any problems. Maybe this particular method doesn't care that myString is null (the string comparison returns false, but that's it), but what about elsewhere? Now there's this null value working its way through your logic that's not supposed to be there.
In this particular case, it might not matter, but in another, letting this invalid value pass through part of the logic could lead to an incorrect state later on (e.g. an address with the city missing). Fail early!
If myString should not be null, then write the code so that it can't be. Add contracts to your methods, or at least some in-method argument validation to ensure invalid values are dealt with before the method's logic ever executes. Then be sure your tests cover these cases.
One goal of programming is robust code, ie. code that doesn't die horribly whenever something unexpected crops up.
in case of if ("abc".equals(myString)), the if clause doesn't get executed if the string is null, so throwing an exception isn't necessary. Of course it could be caused by bugs in code, but those should be found during developing/testing, not in production, by the customer!
Actually, i would take "abc".equals(myString) as an indication that the programmer explicitly didn't care whether the string was null or not. In critical code, i'd expect a lot more explicit checking.
Videos
To the question of whether this asymmetry is inconsistent, I think not, and I refer you to this ancient Zen kลan:
- Ask any man if he's as good as the next man and each will say yes.
- Ask any man if he's as good as nobody and each will say no.
- Ask nobody if it's as good as any man and you'll never get a reply.
At that moment, the compiler reached enlightenment.
An exception really should be an exceptional situation. A null pointer might not be a programmer error.
You quoted the existing contract. If you decide to go against convention, after all this time, when every Java developer expects equals to return false, you'll be doing something unexpected and unwelcome that will make your class a pariah.
I could't disagree more. I would not rewrite equals to throw an exception all the time. I'd replace any class that did that if I were its client.
There are two overarching types of variables in Java:
Primitives: variables that contain data. If you want to manipulate the data in a primitive variable you can manipulate that variable directly. By convention primitive types start with a lowercase letter. For example variables of type
intorcharare primitives.References: variables that contain the memory address of an
Objecti.e. variables that refer to anObject. If you want to manipulate theObjectthat a reference variable refers to you must dereference it. Dereferencing usually entails using.to access a method or field, or using[to index an array. By convention reference types are usually denoted with a type that starts in uppercase. For example variables of typeObjectare references.
Consider the following code where you declare a variable of primitive type int and don't initialize it:
int x;
int y = x + x;
These two lines will crash the program because no value is specified for x and we are trying to use x's value to specify y. All primitives have to be initialized to a usable value before they are manipulated.
Now here is where things get interesting. Reference variables can be set to null which means "I am referencing nothing". You can get a null value in a reference variable if you explicitly set it that way, or a reference variable is uninitialized and the compiler does not catch it (Java will automatically set the variable to null).
If a reference variable is set to null either explicitly by you or through Java automatically, and you attempt to dereference it you get a NullPointerException.
The NullPointerException (NPE) typically 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. So you have a reference to something that does not actually exist.
Take the following code:
Integer num;
num = new Integer(10);
The first line declares a variable named num, but it does not actually contain a reference value yet. Since you have not yet said what to point to, Java sets it to null.
In the second line, the new keyword is used to instantiate (or create) an object of type Integer, and the reference variable num is assigned to that Integer object.
If you attempt to dereference num before creating the object you get a NullPointerException. 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:
public void doSomething(SomeObject obj) {
// Do something to obj, assumes obj is not null
obj.myMethod();
}
In which case, you are not creating the object obj, but rather assuming that it was created before the doSomething() method was called. Note, it is possible to call the method like this:
doSomething(null);
In which case, obj is null, and the statement obj.myMethod() will throw a NullPointerException.
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 NullPointerExceptions thrown as a result of the method's logic, you can also check the method arguments for null values and throw NPEs explicitly by adding something like the following near the beginning of a method:
// Throws an NPE with a custom error message if obj is null
Objects.requireNonNull(obj, "obj must not be null");
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 unless obj 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:
/**
* @param obj An optional foo for ____. May be null, in which case
* the result will be ____.
*/
public void doSomething(SomeObject obj) {
if(obj == null) {
// Do something
} else {
// Do something else
}
}
Finally, How to pinpoint the exception & cause using Stack Trace
What methods/tools can be used to determine the cause so that you stop the exception from causing the program to terminate prematurely?
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:
in thread "main" java.lang.NullPointerException: Cannot invoke "java.util.List.size()" because "list" is null
List of situations that cause a NullPointerException to occur
Here are all the situations in which a NullPointerException occurs, that are directly* mentioned by the Java Language Specification:
- Accessing (i.e. getting or setting) an instance field of a null reference. (static fields don't count!)
- Calling an instance method of a null reference. (static methods don't count!)
throw null;- Accessing elements of a null array.
- Synchronising on null -
synchronized (someNullReference) { ... } - Any integer/floating point operator can throw a
NullPointerExceptionif one of its operands is a boxed null reference - An unboxing conversion throws a
NullPointerExceptionif the boxed value is null. - Calling
superon a null reference throws aNullPointerException. If you are confused, this is talking about qualified superclass constructor invocations:
class Outer {
class Inner {}
}
class ChildOfInner extends Outer.Inner {
ChildOfInner(Outer o) {
o.super(); // if o is null, NPE gets thrown
}
}
Using a
for (element : iterable)loop to loop through a null collection/array.switch (foo) { ... }(whether its an expression or statement) can throw aNullPointerExceptionwhenfoois null.foo.new SomeInnerClass()throws aNullPointerExceptionwhenfoois null.Method references of the form
name1::name2orprimaryExpression::namethrows aNullPointerExceptionwhen evaluated whenname1orprimaryExpressionevaluates to null.a note from the JLS here says that,
someInstance.someStaticMethod()doesn't throw an NPE, becausesomeStaticMethodis static, butsomeInstance::someStaticMethodstill throw an NPE!
* Note that the JLS probably also says a lot about NPEs indirectly.
NullPointerExceptions 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 a NullPointerException. These are the most common, but other ways are listed on the NullPointerException javadoc page.
Probably the quickest example code I could come up with to illustrate a NullPointerException would be:
public class Example {
public static void main(String[] args) {
Object obj = null;
obj.hashCode();
}
}
On the first line inside main, I'm explicitly setting the Object reference obj equal to null. 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 a NullPointerException 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.)
I am writing a program for Servlets and coming across an error:
java.lang.NullPointerException: Cannot invoke "String.equals(Object)" because "condition" is null.
What I am trying to here is to print the form as a response to the client if the terms and conditions are not met.
web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>
first
</servlet-name>
<servlet-class>
com.servlets.MyServlet
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>
first
</servlet-name>
<url-pattern>
/RegisterServlet
</url-pattern>
</servlet-mapping>
<session-config>
<session-timeout>
30
</session-timeout>
</session-config>
</web-app>index.html
<!DOCTYPE html>
<html>
<head>
<title>Form Page</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<style >
.container{
width:40%;
border:1px solid black;
margin:auto;
padding:20px;
}
</style>
</head>
<body>
<div class="container">
<h1 style="text-align:center">My Form</h1>
<form action="RegisterServlet" method="post">
<table>
<tr>
<td>Enter your name</td>
<td><input type="text" name="user_name" placeholder="Enter here"></td>
</tr>
<tr>
<td>Enter the password:</td>
<td><input type="password" name="user_password" placeholder="Enetr the password"></td>
</tr>
<tr>
<td>Enter your email:</td>
<td><input type="email" name="user_email" placeholder="Enter your email"></td>
</tr>
<tr>
<td>Select Gender:</td>
<td><input type="radio" name="user-gender" value="male">Male <input type="radio" name="user-gender" value="female">Female</td>
</tr>
<tr>
<td>Select your course:</td>
<td>
<select name="user-course">
<option value="Java">Java</option>
<option value="C">C</option>
<option value="C++">C++</option>
<option value="PHP">Php</option>
</select>
</td>
</tr>
<tr>
<td style="text-align:center">
<input type="checkbox" value="checked" name="condition"/>
</td>
<td>
Agree terms and conditions
</td>
</tr>
<tr>
<td>
</td>
<td>
<button type="submit">Register</button>
<button type="reset">Reset</button>
</td>
</tr>
</table>
</form>
</div>
</body>
</html>MyServlet.java
/*
* Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
* Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
*/
package com.servlets;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.*;
/**
*
* @author PC
*/
public class MyServlet extends HttpServlet {
/**
*
* @param request
* @param response
* @throws IOException
*/
@Override
public void doPost(HttpServletRequest request,HttpServletResponse response) throws IOException, ServletException{
response.setContentType("text/html");
// Writing the message on the web page
PrintWriter out = response.getWriter();
out.println("<h2>Welcome to servlet</h2>");
String name=request.getParameter("user_name");
String password=request.getParameter("user_password");
String email=request.getParameter("user_email");
String gender=request.getParameter("user_gender");
String course=request.getParameter("user_course");
String condition=request.getParameter("condition");
if(condition!=null){
if(condition.equals("checked")){
out.println("<h2>"+"Name:"+name+"</h2>");
out.println("Password:"+password);
out.println("Email:"+email);
out.println("Gender:"+gender);
out.println("Course:"+course);
}else{
out.println("The terms and conditions have not been agreed upon");
}
}
else{
out.println("The terms and conditions have not been agreed upon");
RequestDispatcher rd=request.getRequestDispatcher("index.html");
rd.include(request,response);
}
}
}You can use a helper method like
public static boolean isEqual(Object o1, Object o2) {
return o1 == o2 || (o1 != null && o1.equals(o2));
}
Google Guava provides Objects.equal(Object, Object) which checks for equality while taking into consideration that either of the parameters might be null:
...
return Objects.equal(this.getStreet(), other.getStreet())
&& Objects.equal(this.getStreetNumber(), other.getStreetNumber())
&& Objects.equal(this.getStreetLetter(), other.getStreetLetter())
&& Objects.equal(this.getTown(), other.getTown());
It's also worth pointing out that Objects has other helper methods for implementing hashCode() and toString().