Package org.openrewrite.staticanalysis.maven

Class MavenJavadocNonAsciiRecipe

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.staticanalysis.maven.MavenJavadocNonAsciiRecipe
All Implemented Interfaces:
Cloneable
public class MavenJavadocNonAsciiRecipe extends org.openrewrite.Recipe
Maven's javadoc-plugin configuration does not support non-ASCII characters in Javadoc comments. This can cause build failures with ambiguous error messages that don't clearly indicate the root cause.

This recipe removes non-ASCII characters from Javadoc comments by: 1. Normalizing text using Unicode NFKD form 2. Removing any characters that are not in the ASCII character set

This is particularly useful when working with international codebases or when comments contain accented characters, special symbols, or other non-ASCII content.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.openrewrite.Recipe

    org.openrewrite.Recipe.Builder, org.openrewrite.Recipe.DelegatingRecipe

  • Field Summary

    Fields inherited from class org.openrewrite.Recipe

    contributors, examples, PANIC

  • Constructor Summary

    Constructors
    Constructor
    Description
    MavenJavadocNonAsciiRecipe()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
     
    String
    getDisplayName()
     
    org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>
    getVisitor()
     

    Methods inherited from class org.openrewrite.Recipe

    addDataTable, builder, buildRecipeList, causesAnotherCycle, clone, createRecipeDescriptor, equals, getContributors, getDataTableDescriptors, getDescriptor, getEstimatedEffortPerOccurrence, getExamples, getInstanceName, getInstanceNameSuffix, getJacksonPolymorphicTypeTag, getMaintainers, getName, getRecipeList, getTags, hashCode, maxCycles, noop, onComplete, run, run, run, setContributors, setExamples, validate, validate, validateAll, validateAll

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MavenJavadocNonAsciiRecipe

      public MavenJavadocNonAsciiRecipe()

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Specified by:
      getDisplayName in class org.openrewrite.Recipe

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in class org.openrewrite.Recipe

    • getVisitor

      public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getVisitor()
      Overrides:
      getVisitor in class org.openrewrite.Recipe