Package org.openrewrite.kotlin

Class AddImport<P>

java.lang.Object

org.openrewrite.TreeVisitor<org.openrewrite.java.tree.J,P>

org.openrewrite.java.JavaVisitor<P>

org.openrewrite.kotlin.KotlinVisitor<P>

org.openrewrite.kotlin.KotlinIsoVisitor<P>

org.openrewrite.kotlin.AddImport<P>

public class AddImport<P>
extends KotlinIsoVisitor<P>

A Kotlin refactoring visitor that can be used to add imports to a given compilation unit. This visitor can also be configured to only add the import if the imported class / member is referenced within the compilation unit.

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

The member is an optional member within the imported type. It can be set to "*" to represent a wildcard import.

The import can optionally also be configured with an alias.

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

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)

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.kotlin.KotlinIsoVisitor

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

Methods inherited from class org.openrewrite.kotlin.KotlinVisitor

autoFormat, autoFormat, autoFormat, getLanguage, isAcceptable, maybeAutoFormat, maybeAutoFormat, maybeAutoFormat, visitAnnotatedExpression, visitContainer, visitContainer, visitLeftPadded, visitMarker, visitNamedVariableInitializer, visitRightPadded, visitRightPadded, visitSpace

Methods inherited from class org.openrewrite.java.JavaVisitor

getJavadocVisitor, isInSameNameScope, isInSameNameScope, maybeAddImport, maybeAddImport, maybeAddImport, maybeAddImport, maybeAddImport, maybeAddImport, maybeRemoveImport, maybeRemoveImport, service, visitContainer, visitLeftPadded, visitRightPadded, visitSpace, visitType, visitTypeName, visitUnknown, visitUnknownSource

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, 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(@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>