Package org.openrewrite.java

Class AddImport<P>

java.lang.Object

org.openrewrite.TreeVisitor<org.openrewrite.java.tree.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 typeName must be supplied and together with the optional packageName represents the fully qualified class name.

The member 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.

Field Summary

Fields inherited from class org.openrewrite.java.JavaVisitor

javadocVisitor

Constructor Summary

Constructors

Constructor	Description
AddImport(@Nullable String packageName, String typeName, @Nullable String member, @Nullable String alias, boolean onlyIfReferenced)
AddImport(String type, @Nullable String member, boolean onlyIfReferenced)

Method Summary

Modifier and Type	Method	Description
@Nullable org.openrewrite.java.tree.J	preVisit(org.openrewrite.java.tree.J tree, P p)

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, visitLabel, visitLambda, visitLiteral, visitMemberReference, visitMethodDeclaration, visitMethodInvocation, visitMultiCatch, visitNewArray, visitNewClass, visitPackage, visitParameterizedType, visitParentheses, visitPrimitive, visitReturn, visitStatement, visitSwitch, visitSwitchExpression, visitSynchronized, visitTernary, visitThrow, visitTry, visitTryResource, visitTypeCast, visitTypeParameter, visitUnary, visitUnknown, visitUnknownSource, visitVariable, visitVariableDeclarations, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class org.openrewrite.java.JavaVisitor

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

Methods inherited from class org.openrewrite.TreeVisitor

adapt, collect, collect, defaultValue, doAfterVisit, getAfterVisit, getCursor, isAdaptableTo, noop, postVisit, reduce, reduce, reduce, setCursor, stopAfterPreVisit, updateCursor, visit, visit, visit, visitAndCast, visitAndCast, visitMarker, visitMarkers, visitNonNull, visitNonNull, visitorTreeType

Methods inherited from class java.lang.Object

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

Constructor Details

AddImport

public AddImport(String type,
 @Nullable
 @Nullable String member,
 boolean onlyIfReferenced)

AddImport

public AddImport(@Nullable
 @Nullable String packageName,
 String typeName,
 @Nullable
 @Nullable String member,
 @Nullable
 @Nullable String alias,
 boolean onlyIfReferenced)

Method Details

preVisit

@Nullable
public @Nullable org.openrewrite.java.tree.J preVisit(org.openrewrite.java.tree.J tree,
 P p)

Overrides:

preVisit in class org.openrewrite.TreeVisitor<org.openrewrite.java.tree.J,P>