Skip to main content

Convert annotated abstract method to field

org.openrewrite.tapestry.ConvertAnnotatedMethodToField

Converts abstract getter methods annotated with sourceAnnotation to private fields annotated with targetAnnotation. Also removes corresponding abstract setter methods.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringsourceAnnotationThe fully qualified name of the annotation to find on abstract getter methods.org.apache.tapestry.annotations.InjectObject
StringtargetAnnotationThe fully qualified name of the annotation to add to the generated field.org.apache.tapestry5.ioc.annotations.Inject
BooleanpreserveAnnotationArgumentsOptional. When true, copies the source annotation's arguments to the target annotation. Use this when the annotation arguments carry semantic meaning in the target framework (e.g., @Persist("session"), @Parameter(required=true)).true

Used by​

This recipe is used as part of the following composite recipes:

Examples​

Example 1​

ConvertInjectObjectToInjectTest#convertsInjectObjectToInject

Parameters​
ParameterValue
sourceAnnotationorg.apache.tapestry.annotations.InjectObject
targetAnnotationorg.apache.tapestry5.ioc.annotations.Inject
preserveAnnotationArgumentsnull
Before​
import org.apache.tapestry.annotations.InjectObject;

public abstract class MyPage {

    @InjectObject("service:myService")
    public abstract MyService getMyService();

    public void doWork() {
        getMyService().doSomething();
    }
}
After​
import org.apache.tapestry5.ioc.annotations.Inject;

public abstract class MyPage {
    @Inject private MyService myService;

    public void doWork() {
        getMyService().doSomething();
    }
}
Example 2​

ConvertPersistAnnotationTest#convertsPersistGetterToField

Parameters​
ParameterValue
sourceAnnotationorg.apache.tapestry.annotations.Persist
targetAnnotationorg.apache.tapestry5.annotations.Persist
preserveAnnotationArgumentstrue
Before​
import org.apache.tapestry.annotations.Persist;

public abstract class MyPage {

    @Persist
    public abstract String getMessage();
}
After​
import org.apache.tapestry5.annotations.Persist;

public abstract class MyPage {
    @Persist private String message;
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ConvertAnnotatedMethodToFieldExample
displayName: Convert annotated abstract method to field example
recipeList:
  - org.openrewrite.tapestry.ConvertAnnotatedMethodToField:
      sourceAnnotation: org.apache.tapestry.annotations.InjectObject
      targetAnnotation: org.apache.tapestry5.ioc.annotations.Inject
      preserveAnnotationArguments: true

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

shell
mod run . --recipe ConvertAnnotatedMethodToField --recipe-option "sourceAnnotation=org.apache.tapestry.annotations.InjectObject" --recipe-option "targetAnnotation=org.apache.tapestry5.ioc.annotations.Inject" --recipe-option "preserveAnnotationArguments=true"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-tapestry:0.2.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.