Package org.openrewrite.gradle

Class ExamplesExtractor

java.lang.Object
org.openrewrite.TreeVisitor<org.openrewrite.java.tree.J,P>
org.openrewrite.java.JavaVisitor<P>
org.openrewrite.java.JavaIsoVisitor<org.openrewrite.ExecutionContext>
org.openrewrite.gradle.ExamplesExtractor
public class ExamplesExtractor extends org.openrewrite.java.JavaIsoVisitor<org.openrewrite.ExecutionContext>
Extract recipe examples from a test file which are annotated with @DocumentExample Output is the content of the yaml file to present examples Format is like: 
               type: specs.openrewrite.org/v1beta/example
               recipeName: test.ChangeTextToHello
               examples:
                 - description: "Change World to Hello in a text file"
                   before: "World"
                   after: "Hello!"
                   language: "text"
                 - description: "Change World to Hello in a java file"
                   before: |
                     public class A {
                         void method() {
                             System.out.println("World");
                         }
                     }
                   after: |
                     public class A {
                         void method() {
                             System.out.println("Hello!");
                         }
                     }
                   language: "java"

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ExamplesExtractor.YamlPrinter
     

  • Field Summary

    Fields inherited from class org.openrewrite.java.JavaVisitor

    javadocVisitor

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExamplesExtractor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    printRecipeExampleYaml()
    print the recipe example yaml.
    org.openrewrite.java.tree.J.MethodDeclaration
    visitMethodDeclaration(org.openrewrite.java.tree.J.MethodDeclaration method, org.openrewrite.ExecutionContext ctx)
     
    org.openrewrite.java.tree.J.MethodInvocation
    visitMethodInvocation(org.openrewrite.java.tree.J.MethodInvocation method, org.openrewrite.ExecutionContext ctx)
     

    Methods inherited from class org.openrewrite.java.JavaIsoVisitor

    visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayDimension, visitArrayType, visitAssert, visitAssignment, visitAssignmentOperation, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClassDeclaration, visitCompilationUnit, visitContinue, visitControlParentheses, visitDoWhileLoop, visitElse, visitEmpty, visitEnumValue, visitEnumValueSet, visitExpression, visitFieldAccess, visitForControl, visitForEachControl, visitForEachLoop, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitJavaSourceFile, visitLabel, visitLambda, visitLiteral, visitMemberReference, visitMultiCatch, visitNewArray, visitNewClass, visitPackage, visitParameterizedType, visitParentheses, visitPrimitive, visitReturn, visitStatement, visitSwitch, visitSwitchExpression, visitSynchronized, visitTernary, visitThrow, visitTry, visitTryResource, visitTypeCast, visitTypeParameter, visitUnary, visitVariable, visitVariableDeclarations, visitWhileLoop, visitWildcard, visitYield

    Methods inherited from class org.openrewrite.java.JavaVisitor

    autoFormat, autoFormat, autoFormat, describeLocation, getJavadocVisitor, getLanguage, isAcceptable, isInSameNameScope, isInSameNameScope, maybeAddImport, maybeAddImport, maybeAddImport, maybeAddImport, maybeAddImport, maybeAutoFormat, maybeAutoFormat, maybeAutoFormat, maybeRemoveImport, maybeRemoveImport, visitContainer, visitLeftPadded, visitRightPadded, visitSpace, visitType, visitTypeName

    Methods inherited from class org.openrewrite.TreeVisitor

    adapt, collect, collect, defaultValue, doAfterVisit, doAfterVisit, getAfterVisit, getCursor, isAdaptableTo, noop, postVisit, preVisit, reduce, reduce, reduce, setCursor, visit, visit, visit, visitAndCast, visitAndCast, visitMarker, visitMarkers, visitNonNull, visitNonNull, visitSourceFile

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExamplesExtractor

      public ExamplesExtractor()

  • Method Details

    • printRecipeExampleYaml

      public String printRecipeExampleYaml()
      print the recipe example yaml.

    • visitMethodDeclaration

      public org.openrewrite.java.tree.J.MethodDeclaration visitMethodDeclaration(org.openrewrite.java.tree.J.MethodDeclaration method, org.openrewrite.ExecutionContext ctx)
      Overrides:
      visitMethodDeclaration in class org.openrewrite.java.JavaIsoVisitor<org.openrewrite.ExecutionContext>

    • visitMethodInvocation

      public org.openrewrite.java.tree.J.MethodInvocation visitMethodInvocation(org.openrewrite.java.tree.J.MethodInvocation method, org.openrewrite.ExecutionContext ctx)
      Overrides:
      visitMethodInvocation in class org.openrewrite.java.JavaIsoVisitor<org.openrewrite.ExecutionContext>