Adds missing JDBC interface methods.

org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods

Add method implementations stubs to classes that implement JDBC interfaces.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-migrate-java

• version: 2.12.0

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.12.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>2.12.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe JREJdbcInterfaceNewMethods

Definition

Recipe List

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Connection

  • methodPattern: *..* abort(java.util.concurrent.Executor)

  • methodTemplateString: public void abort(java.util.concurrent.Executor executor) { // TODO Auto-generated method stub }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Connection

  • methodPattern: *..* getNetworkTimeout()

  • methodTemplateString: public int getNetworkTimeout() { // TODO Auto-generated method stub return 0; }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Connection

  • methodPattern: *..* getSchema()

  • methodTemplateString: public java.lang.String getSchema() { // TODO Auto-generated method stub return null; }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Connection

  • methodPattern: *..* setNetworkTimeout(java.util.concurrent.Executor, int)

  • methodTemplateString: public void setNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds) { // TODO Auto-generated method stub }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Connection

  • methodPattern: *..* setSchema(java.lang.String)

  • methodTemplateString: public void setSchema(java.lang.String schema) throws java.sql.SQLException { // TODO Auto-generated method stub }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Driver

  • methodPattern: *..* getParentLogger()

  • methodTemplateString: public java.util.logging.Logger getParentLogger() { // TODO Auto-generated method stub return null; }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Statement

  • methodPattern: *..* closeOnCompletion()

  • methodTemplateString: public void closeOnCompletion() { // TODO Auto-generated method stub }

• Adds missing method implementations

  • fullyQualifiedClassName: java.sql.Statement

  • methodPattern: *..* isCloseOnCompletion()

  • methodTemplateString: public boolean isCloseOnCompletion() { // TODO Auto-generated method stub return false; }

• Adds missing method implementations

  • fullyQualifiedClassName: javax.sql.CommonDataSource

  • methodPattern: *..* getParentLogger()

  • methodTemplateString: public java.util.logging.Logger getParentLogger() { // TODO Auto-generated method stub return null; }

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.JREJdbcInterfaceNewMethods
displayName: Adds missing JDBC interface methods.
description: Add method implementations stubs to classes that implement JDBC interfaces.
recipeList:
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Connection
      methodPattern: *..* abort(java.util.concurrent.Executor)
      methodTemplateString: public void abort(java.util.concurrent.Executor executor) { 
	// TODO Auto-generated method stub
 }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Connection
      methodPattern: *..* getNetworkTimeout()
      methodTemplateString: public int getNetworkTimeout() { 
	// TODO Auto-generated method stub
 return 0; }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Connection
      methodPattern: *..* getSchema()
      methodTemplateString: public java.lang.String getSchema() { 
	// TODO Auto-generated method stub
 return null; }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Connection
      methodPattern: *..* setNetworkTimeout(java.util.concurrent.Executor, int)
      methodTemplateString: public void setNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds) { 
	// TODO Auto-generated method stub
 }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Connection
      methodPattern: *..* setSchema(java.lang.String)
      methodTemplateString: public void setSchema(java.lang.String schema) throws java.sql.SQLException { 
	// TODO Auto-generated method stub
 }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Driver
      methodPattern: *..* getParentLogger()
      methodTemplateString: public java.util.logging.Logger getParentLogger() { 
	// TODO Auto-generated method stub
 return null; }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Statement
      methodPattern: *..* closeOnCompletion()
      methodTemplateString: public void closeOnCompletion() { 
	// TODO Auto-generated method stub
 }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: java.sql.Statement
      methodPattern: *..* isCloseOnCompletion()
      methodTemplateString: public boolean isCloseOnCompletion() { 
	// TODO Auto-generated method stub
 return false; }
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: javax.sql.CommonDataSource
      methodPattern: *..* getParentLogger()
      methodTemplateString: public java.util.logging.Logger getParentLogger() { 
	// TODO Auto-generated method stub
 return null; }

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.

Contributors

Chuka Obinabo, Daryl Robbins, Tim te Beek