Package org.openrewrite.java

Class AddImport<P>

java.lang.Object

org.openrewrite.TreeVisitor<J,P>

org.openrewrite.java.JavaVisitor<P>

org.openrewrite.java.JavaIsoVisitor<P>

org.openrewrite.java.AddImport<P>

public class AddImport<P>
extends JavaIsoVisitor<P>

A Java refactoring visitor that can be used to add an import (or static import) to a given compilation unit. This visitor can also be configured to only add the import if the imported class/method are referenced within the compilation unit.

The type must be supplied and represents a fully qualified class name.

The statik is an optional method within the imported type. The staticMethod can be set to "*" to represent a static wildcard import.

The onlyIfReferenced is a flag (defaulted to true) to indicate if the import should only be added if there is a reference to the imported class/method.

Constructor Summary

Constructors

Constructor	Description
AddImport(java.lang.String type, @Nullable java.lang.String statik, boolean onlyIfReferenced)

Method Summary

Modifier and Type	Method	Description
J.CompilationUnit	visitCompilationUnit(J.CompilationUnit cu, P p)

Methods inherited from class org.openrewrite.java.JavaIsoVisitor

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

Methods inherited from class org.openrewrite.java.JavaVisitor

autoFormat, autoFormat, autoFormat, getLanguage, isInSameNameScope, isInSameNameScope, maybeAddImport, maybeAddImport, maybeAddImport, maybeAutoFormat, maybeAutoFormat, maybeAutoFormat, maybeRemoveImport, maybeRemoveImport, visitContainer, visitForControl, visitForEachControl, visitLeftPadded, visitRightPadded, visitSpace, visitTypeName, visitVarType

Methods inherited from class org.openrewrite.TreeVisitor

debugOnChange, defaultValue, doAfterVisit, doAfterVisit, getAfterVisit, getCursor, postVisit, preVisit, setCursor, visit, visit, visitAndCast, visitAndCast, visitMarker, visitMarkers

Methods inherited from class java.lang.Object

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

Constructor Detail

AddImport

public AddImport(java.lang.String type,
                 @Nullable
                 @Nullable java.lang.String statik,
                 boolean onlyIfReferenced)

Method Detail

visitCompilationUnit

public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu,
                                              P p)

Overrides:

visitCompilationUnit in class JavaIsoVisitor<P>