Prefer Math#clamp

org.openrewrite.java.migrate.guava.PreferMathClamp

Prefer java.lang.Math#clamp instead of using com.google.common.primitives.*#constrainToRange.

Tags

• guava

• java21

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.guava.PreferMathClamp")
}

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.guava.PreferMathClamp")
    }
    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.guava.PreferMathClamp</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.guava.PreferMathClamp

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 PreferMathClamp

Definition

Recipe List

• Change method name

  • methodPattern: com.google.common.primitives.Doubles constrainToRange(..)

  • newMethodName: clamp

• Change method target to static

  • methodPattern: com.google.common.primitives.Doubles clamp(..)

  • fullyQualifiedTargetTypeName: java.lang.Math

• Change method name

  • methodPattern: com.google.common.primitives.Floats constrainToRange(..)

  • newMethodName: clamp

• Change method target to static

  • methodPattern: com.google.common.primitives.Floats clamp(..)

  • fullyQualifiedTargetTypeName: java.lang.Math

• Change method name

  • methodPattern: com.google.common.primitives.Longs constrainToRange(..)

  • newMethodName: clamp

• Change method target to static

  • methodPattern: com.google.common.primitives.Longs clamp(..)

  • fullyQualifiedTargetTypeName: java.lang.Math

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.guava.PreferMathClamp
displayName: Prefer `Math#clamp`
description: Prefer `java.lang.Math#clamp` instead of using `com.google.common.primitives.*#constrainToRange`.
tags:
  - guava
  - java21
recipeList:
  - org.openrewrite.java.ChangeMethodName:
      methodPattern: com.google.common.primitives.Doubles constrainToRange(..)
      newMethodName: clamp
  - org.openrewrite.java.ChangeMethodTargetToStatic:
      methodPattern: com.google.common.primitives.Doubles clamp(..)
      fullyQualifiedTargetTypeName: java.lang.Math
  - org.openrewrite.java.ChangeMethodName:
      methodPattern: com.google.common.primitives.Floats constrainToRange(..)
      newMethodName: clamp
  - org.openrewrite.java.ChangeMethodTargetToStatic:
      methodPattern: com.google.common.primitives.Floats clamp(..)
      fullyQualifiedTargetTypeName: java.lang.Math
  - org.openrewrite.java.ChangeMethodName:
      methodPattern: com.google.common.primitives.Longs constrainToRange(..)
      newMethodName: clamp
  - org.openrewrite.java.ChangeMethodTargetToStatic:
      methodPattern: com.google.common.primitives.Longs clamp(..)
      fullyQualifiedTargetTypeName: java.lang.Math

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.