Package org.openrewrite.java

Class AddCommentToMethod

java.lang.Object
org.openrewrite.Recipe
org.openrewrite.java.AddCommentToMethod
All Implemented Interfaces:
Cloneable
public class AddCommentToMethod extends org.openrewrite.Recipe
This recipe adds a comment to method declarations in a Java source file. The comment can be a single line or a multiline comment.

The comment must be supplied and is the comment to add.

The methodPattern is a pattern to match methods to add the comment to.

The isMultiline is an optional flag (defaulted to false) to indicate if the comment is a multiline comment.

  • 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
    AddCommentToMethod()
     

  • Method Summary

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

    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, validateAll, validateAll

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AddCommentToMethod

      public AddCommentToMethod()

  • 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

    • validate

      public org.openrewrite.Validated<Object> validate()
      Overrides:
      validate in class org.openrewrite.Recipe

    • getVisitor

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