equalsavoidsnull.md

Equals avoids null

org.openrewrite.staticanalysis.EqualsAvoidsNull

Checks that any combination of String literals is on the left side of an equals() comparison. Also checks for String literals assigned to some field (such as someString.equals(anotherString = "text")).

Tags

• RSPEC-1132

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-static-analysis
• version: 1.0.1

Example

{% tabs %} {% tab title="A.java" %}

Before

{% code title="A.java" %}

public class A {
    {
        String s = null;
        if(s.equals("test")) {}
        if(s.equalsIgnoreCase("test")) {}
    }
}

{% endcode %}

After

{% code title="A.java" %}

public class A {
    {
        String s = null;
        if("test".equals(s)) {}
        if("test".equalsIgnoreCase(s)) {}
    }
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- A.java
+++ A.java
@@ -4,2 +4,2 @@
    {
        String s = null;
-       if(s.equals("test")) {}
-       if(s.equalsIgnoreCase("test")) {}
+       if("test".equals(s)) {}
+       if("test".equalsIgnoreCase(s)) {}
    }

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-static-analysis:1.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.staticanalysis.EqualsAvoidsNull")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:1.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.staticanalysis.EqualsAvoidsNull</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-static-analysis</artifactId>
            <version>1.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-static-analysis:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.staticanalysis.EqualsAvoidsNull

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Knut Wannheden
• Aaron Gershman
• Sam Snyder

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.