Package com.intellij.psi.impl.source.codeStyle

Class ImportHelper

java.lang.Object

com.intellij.psi.impl.source.codeStyle.ImportHelper

public class ImportHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ImportHelper(CodeStyleSettings settings) Deprecated. Use ImportHelper(JavaCodeStyleSettings) instead. The instance of JavaCodeStyleSettings can be obtained using JavaCodeStyleSettings.getInstance(PsiFile) method.
ImportHelper(JavaCodeStyleSettings settings)

Method Summary

Modifier and Type	Method and Description
boolean	addImport(PsiJavaFile file, PsiClass refClass) Adds import if it is needed.
static void	collectOnDemandImports(java.util.List<? extends Pair<java.lang.String,java.lang.Boolean>> resultList, JavaCodeStyleSettings settings, java.util.Map<java.lang.String,java.lang.Boolean> outClassesOrPackagesToImportOnDemand)
ASTNode	getDefaultAnchor(PsiImportList list, PsiImportStatementBase statement)
int	getEmptyLinesBetween(PsiImportStatementBase statement1, PsiImportStatementBase statement2)
static boolean	hasConflictingOnDemandImport(PsiJavaFile file, PsiClass psiClass, java.lang.String referenceName)
static boolean	isAlreadyImported(PsiJavaFile file, java.lang.String fullyQualifiedName)
PsiImportList	prepareOptimizeImportsResult(PsiJavaFile file)
PsiImportList	prepareOptimizeImportsResult(PsiJavaFile file, java.util.function.Predicate<? super Pair<java.lang.String,java.lang.Boolean>> filter)
static java.util.List<Pair<java.lang.String,java.lang.Boolean>>	sortItemsAccordingToSettings(java.util.List<? extends Pair<java.lang.String,java.lang.Boolean>> names, JavaCodeStyleSettings settings)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportHelper

public ImportHelper(JavaCodeStyleSettings settings)

ImportHelper

@Deprecated
public ImportHelper(CodeStyleSettings settings)

Deprecated. Use ImportHelper(JavaCodeStyleSettings) instead. The instance of JavaCodeStyleSettings can be obtained using JavaCodeStyleSettings.getInstance(PsiFile) method.

Method Detail

prepareOptimizeImportsResult

public PsiImportList prepareOptimizeImportsResult(PsiJavaFile file)

prepareOptimizeImportsResult

public PsiImportList prepareOptimizeImportsResult(PsiJavaFile file,
                                                  java.util.function.Predicate<? super Pair<java.lang.String,java.lang.Boolean>> filter)

Parameters:

filter - pretend some references do not exist so the corresponding imports may be deleted

collectOnDemandImports

public static void collectOnDemandImports(java.util.List<? extends Pair<java.lang.String,java.lang.Boolean>> resultList,
                                          JavaCodeStyleSettings settings,
                                          java.util.Map<java.lang.String,java.lang.Boolean> outClassesOrPackagesToImportOnDemand)

sortItemsAccordingToSettings

public static java.util.List<Pair<java.lang.String,java.lang.Boolean>> sortItemsAccordingToSettings(java.util.List<? extends Pair<java.lang.String,java.lang.Boolean>> names,
                                                                                                    JavaCodeStyleSettings settings)

addImport

public boolean addImport(PsiJavaFile file,
                         PsiClass refClass)

Adds import if it is needed.

Returns:

false when the FQ-name have to be used in code (e.g. when conflicting imports already exist)

isAlreadyImported

public static boolean isAlreadyImported(PsiJavaFile file,
                                        java.lang.String fullyQualifiedName)

getDefaultAnchor

public ASTNode getDefaultAnchor(PsiImportList list,
                                PsiImportStatementBase statement)

getEmptyLinesBetween

public int getEmptyLinesBetween(PsiImportStatementBase statement1,
                                PsiImportStatementBase statement2)

hasConflictingOnDemandImport

public static boolean hasConflictingOnDemandImport(PsiJavaFile file,
                                                   PsiClass psiClass,
                                                   java.lang.String referenceName)