org.openrewrite.java.migrate.lang.UseTextBlocks
Text blocks are easier to read than concatenated strings.
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite.recipe
- artifactId: rewrite-migrate-java
- version: 2.0.1
| Type | Name | Description |
|---|---|---|
boolean |
convertStringsWithoutNewlines | Optional. Whether or not strings without newlines should be converted to text block when processing code. The default value is true. |
{% tabs %} {% tab title="Test.java" %}
{% code title="Test.java" %}
class Test {
String query = "SELECT * FROM\n" +
"my_table\n" +
"WHERE something = 1;";
}{% endcode %}
{% code title="Test.java" %}
class Test {
String query = """
SELECT * FROM
my_table
WHERE something = 1;\
""";
}{% endcode %}
{% endtab %} {% tab title="Diff" %} {% code %}
--- Test.java
+++ Test.java
@@ -2,3 +2,5 @@
class Test {
- String query = "SELECT * FROM\n" +
- "my_table\n" +
- "WHERE something = 1;";
+ String query = """
+ SELECT * FROM
+ my_table
+ WHERE something = 1;\
+ """;
}{% endcode %} {% endtab %} {% endtabs %}
{% tabs %} {% tab title="A.java" %}
{% code title="A.java" %}
class A {
void welcome() {
log("\n========================================================="
+ "\n "
+ "\n Welcome to Spring Integration! "
+ "\n "
+ "\n For more information please visit: "
+ "\n https://www.springsource.org/spring-integration "
+ "\n "
+ "\n=========================================================");
}
void log(String s) {}
}{% endcode %}
{% code title="A.java" %}
class A {
void welcome() {
log("""
=========================================================
\s
Welcome to Spring Integration! \s
\s
For more information please visit: \s
https://www.springsource.org/spring-integration \s
\s
=========================================================\
""");
}
void log(String s) {}
}{% endcode %}
{% endtab %} {% tab title="Diff" %} {% code %}
--- A.java
+++ A.java
@@ -3,8 +3,11 @@
class A {
void welcome() {
- log("\n========================================================="
- + "\n "
- + "\n Welcome to Spring Integration! "
- + "\n "
- + "\n For more information please visit: "
- + "\n https://www.springsource.org/spring-integration "
- + "\n "
- + "\n=========================================================");
+ log("""
+
+ =========================================================
+ \s
+ Welcome to Spring Integration! \s
+ \s
+ For more information please visit: \s
+ https://www.springsource.org/spring-integration \s
+ \s
+ =========================================================\
+ """);
}{% endcode %} {% endtab %} {% endtabs %}
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.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.java.migrate.lang.UseTextBlocks")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.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.java.migrate.lang.UseTextBlocks</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-migrate-java</artifactId>
<version>2.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-migrate-java:RELEASE \
-Drewrite.activeRecipes=org.openrewrite.java.migrate.lang.UseTextBlocks{% endcode %} {% endtab %} {% endtabs %}
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.