From b38c77ca22649441430b3cf35dacf009f6a034c6 Mon Sep 17 00:00:00 2001 From: Tim te Beek Date: Sun, 4 Feb 2024 17:20:25 +0100 Subject: [PATCH] Add missing example values for UseAsBuilder --- .../org/openrewrite/staticanalysis/UseAsBuilder.java | 11 +++++------ .../HideUtilityClassConstructorTest.java | 4 ++-- .../staticanalysis/RemoveUnusedPrivateFieldsTest.java | 2 +- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/openrewrite/staticanalysis/UseAsBuilder.java b/src/main/java/org/openrewrite/staticanalysis/UseAsBuilder.java index f9563c6b2..2ca74676e 100644 --- a/src/main/java/org/openrewrite/staticanalysis/UseAsBuilder.java +++ b/src/main/java/org/openrewrite/staticanalysis/UseAsBuilder.java @@ -35,24 +35,23 @@ public class UseAsBuilder extends Recipe { @Option( displayName = "Builder Type", - description = "Fully qualified name of the Builder" - ) + description = "Fully qualified name of the Builder", + example = "org.example.Buildable.Builder") String builderType; @Option( displayName = "Immutable state", description = "The builder is immutable if you must assign the result of calls to intermediate variables " + "or use directly. Defaults to true as many purpose-built builders will be immutable.", - required = false - ) + required = false) @Nullable Boolean immutable; @Option( displayName = "Builder creator method", description = "The method that creates the builder instance, which may not be a method of the builder itself.", - required = false - ) + required = false, + example = "org.example.Buildable builder()") @Nullable String builderCreator; diff --git a/src/test/java/org/openrewrite/staticanalysis/HideUtilityClassConstructorTest.java b/src/test/java/org/openrewrite/staticanalysis/HideUtilityClassConstructorTest.java index e7dacc1b6..2c0e808c2 100644 --- a/src/test/java/org/openrewrite/staticanalysis/HideUtilityClassConstructorTest.java +++ b/src/test/java/org/openrewrite/staticanalysis/HideUtilityClassConstructorTest.java @@ -157,7 +157,7 @@ void changeApplicableNestedClass() { public class A { public A() {} public static String foo() { return "foo"; } - private static class Builder() { + private static class Builder { public Builder() {} public static String foo() { return "foo"; } } @@ -167,7 +167,7 @@ public Builder() {} public class A { private A() {} public static String foo() { return "foo"; } - private static class Builder() { + private static class Builder { private Builder() {} public static String foo() { return "foo"; } } diff --git a/src/test/java/org/openrewrite/staticanalysis/RemoveUnusedPrivateFieldsTest.java b/src/test/java/org/openrewrite/staticanalysis/RemoveUnusedPrivateFieldsTest.java index e7c08110a..fb8346b7f 100644 --- a/src/test/java/org/openrewrite/staticanalysis/RemoveUnusedPrivateFieldsTest.java +++ b/src/test/java/org/openrewrite/staticanalysis/RemoveUnusedPrivateFieldsTest.java @@ -237,7 +237,7 @@ public class VehicleUsage { private final String vehicleId; } - public doSomethingWithAVehicle() { + public void doSomethingWithAVehicle() { vehicleUsage = new VehicleUsage(); vehicleUsage.vehicleId = "vu50"; }