findimports.md

Find source files with imports

org.openrewrite.java.search.FindImports

Locates source files that have imports matching the given type pattern, regardless of whether that import is used in the code.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-java
• version: 8.1.3

Options

Type	Name	Description
String	typePattern	Optional. A type pattern that is used to find matching field uses.

Example

Parameters

Parameter	Value
typePattern	java.util..*

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

Before

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

import java.util.concurrent.atomic.AtomicBoolean;
class Test {
}

{% endcode %}

After

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

/*~~>*/import java.util.concurrent.atomic.AtomicBoolean;
class Test {
}

{% endcode %}

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

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import java.util.concurrent.atomic.AtomicBoolean;
+/*~~>*/import java.util.concurrent.atomic.AtomicBoolean;
class Test {

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

Usage

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies. {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

rewrite {
    activeRecipe("org.openrewrite.java.search.FindImports")
}

repositories {
    mavenCentral()
}

{% 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.java.search.FindImports</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

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

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.activeRecipes=org.openrewrite.java.search.FindImports

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

Contributors

• Jonathan Schneider

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.