← All recipes
Open source

Create Java class

Recipe IDorg.openrewrite.java.CreateEmptyJavaClass
Artifactorg.openrewrite:rewrite-java

Create a new, empty Java class.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.CreateEmptyJavaClass --recipe-option "sourceRoot=src/main/java" --recipe-option "packageName=org.openrewrite.example" --recipe-option "modifier=public" --recipe-option "className=ExampleClass"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-java:8.88.0

Options

NameTypeDescription
sourceRootrequiredStringThe source root of the new class file.
e.g. src/main/java
packageNamerequiredStringThe package of the new class.
e.g. org.openrewrite.example
modifierrequiredStringThe class modifier.
e.g. public
classNamerequiredStringFile path of new file.
e.g. ExampleClass
overwriteExistingBooleanIf there is an existing file, should it be overwritten.
relativePathStringDirectory path of new class.
e.g. foo/bar

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats