Fix organize imports to recognize forbidden static favorites (#2924)

- add new JavaElementUtil.isForbiddenOnClasspath() method to figure
  out if a qualified name is forbidden or discouraged on the class path
  of the project of a given type root
- modify UnresolvedElementBaseSubProcessor to use new API
- modify OrganizeImportsOperation to check if a static import from
  the favorites is forbidden in the class path of the compilation unit
- add new test to ImportOrganizeTest1d8
- fixes #2893

Author: jjohnstn

org.eclipse.jdt.core.manipulation/common/org/eclipse/jdt/core/manipulation/OrganizeImportsOperation.java

@@ -78,6 +78,7 @@
 import org.eclipse.jdt.internal.corext.dom.ASTNodes;
 import org.eclipse.jdt.internal.corext.dom.Bindings;
 import org.eclipse.jdt.internal.corext.dom.ScopeAnalyzer;
+import org.eclipse.jdt.internal.corext.refactoring.util.JavaElementUtil;
 import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
 import org.eclipse.jdt.internal.corext.util.JdtFlags;
 import org.eclipse.jdt.internal.corext.util.StaticImportFavoritesCompletionInvoker;
@@ -820,9 +821,14 @@ private void addStaticImports(
 						}
 						String[] staticFavourites= ex.getStaticImportFavorites(identifier, isMethod);
 						fResolvedStaticFavoriteImports.add(identifier);
-						if (staticFavourites.length > 0) {
-							String qualifiedTypeName= Signature.getQualifier(staticFavourites[0]);
-							importRewrite.addStaticImport(qualifiedTypeName, identifier, !isMethod);
+						int i= 0;
+						while (i < staticFavourites.length) {
+							String qualifiedTypeName= Signature.getQualifier(staticFavourites[i]);
+							if (!JavaElementUtil.isForbiddenOnClasspath(importRewrite.getCompilationUnit(), qualifiedTypeName)) {
+								importRewrite.addStaticImport(qualifiedTypeName, identifier, !isMethod);
+								break;
+							}
+							++i;
 						}
 					} catch (JavaModelException e) {
 						return;
@@ -837,7 +843,6 @@ private void addStaticImports(
 		}
 	}
 
-
 	// find type references in a compilation unit
 	private boolean collectReferences(CompilationUnit astRoot, List<SimpleName> typeReferences, List<SimpleName> staticReferences, Set<String> oldSingleImports,
 			Set<String> oldDemandImports, Map<String, Set<String>> oldModuleImports) {

org.eclipse.jdt.core.manipulation/common/org/eclipse/jdt/internal/ui/text/correction/UnresolvedElementsBaseSubProcessor.java

@@ -32,7 +32,6 @@
 
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.FileLocator;
-import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.NullProgressMonitor;
@@ -46,8 +45,6 @@
 import org.eclipse.ltk.core.refactoring.resource.DeleteResourceChange;
 import org.eclipse.ltk.core.refactoring.resource.ResourceChange;
 
-import org.eclipse.jdt.core.IAccessRule;
-import org.eclipse.jdt.core.IClasspathEntry;
 import org.eclipse.jdt.core.ICompilationUnit;
 import org.eclipse.jdt.core.IJavaElement;
 import org.eclipse.jdt.core.IJavaProject;
@@ -59,7 +56,6 @@
 import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.JavaModelException;
 import org.eclipse.jdt.core.Signature;
-import org.eclipse.jdt.core.compiler.CharOperation;
 import org.eclipse.jdt.core.compiler.IProblem;
 import org.eclipse.jdt.core.dom.AST;
 import org.eclipse.jdt.core.dom.ASTMatcher;
@@ -138,6 +134,7 @@
 import org.eclipse.jdt.internal.corext.dom.IASTSharedValues;
 import org.eclipse.jdt.internal.corext.dom.ScopeAnalyzer;
 import org.eclipse.jdt.internal.corext.refactoring.changes.ClasspathChange;
+import org.eclipse.jdt.internal.corext.refactoring.util.JavaElementUtil;
 import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
 import org.eclipse.jdt.internal.corext.util.Messages;
 import org.eclipse.jdt.internal.corext.util.TypeFilter;
@@ -1530,7 +1527,8 @@ private void addStaticImportFavoriteProposals(IInvocationContext context, Simple
 			String qualifiedTypeName= Signature.getQualifier(Signature.getTypeErasure(curr));
 			String elementLabel= BasicElementLabels.getJavaElementName(JavaModelUtil.concatenateName(Signature.getSimpleName(qualifiedTypeName), name));
 
-			if (isForbidden(root, qualifiedTypeName)) {
+			ITypeRoot typeRoot= root.getTypeRoot();
+			if (typeRoot != null && JavaElementUtil.isForbiddenOnClasspath(typeRoot, qualifiedTypeName)) {
 				continue;
 			}
 
@@ -1554,30 +1552,6 @@ private void addStaticImportFavoriteProposals(IInvocationContext context, Simple
 		}
 	}
 
-	private boolean isForbidden(CompilationUnit root, String qualifiedTypeName) throws JavaModelException {
-		String qualifiedPathName= qualifiedTypeName.replace('.', '/');
-		IJavaElement type= root.getJavaElement().getJavaProject().findElement(IPath.fromPortableString(qualifiedPathName).removeLastSegments(1));
-		while (type != null) {
-			IClasspathEntry entry= root.getJavaElement().getJavaProject().getClasspathEntryFor(type.getPath());
-			if (entry != null) {
-				for (IAccessRule rule : entry.getAccessRules()) {
-					if (CharOperation.pathMatch(rule.getPattern().toString().toCharArray(), qualifiedPathName.toCharArray(),
-							true/*case sensitive*/, '/')) {
-						switch (rule.getKind()) {
-							case IAccessRule.K_NON_ACCESSIBLE:
-							case IAccessRule.K_DISCOURAGED:
-								return true;
-							default:
-								break;
-						}
-					}
-				}
-			}
-			type= type.getParent();
-		}
-		return false;
-	}
-
 	// 1400
 	private void addNewMethodProposals(ICompilationUnit cu, CompilationUnit astRoot, Expression sender, List<Expression> arguments, boolean isSuperInvocation, ASTNode invocationNode, String methodName, Collection<T> proposals) throws JavaModelException {
 		ITypeBinding nodeParentType= Bindings.getBindingOfParentType(invocationNode);

org.eclipse.jdt.core.manipulation/core extension/org/eclipse/jdt/internal/corext/refactoring/util/JavaElementUtil.java

@@ -22,9 +22,11 @@
 import java.util.Set;
 
 import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.IPath;
 
 import org.eclipse.core.resources.ResourcesPlugin;
 
+import org.eclipse.jdt.core.IAccessRule;
 import org.eclipse.jdt.core.IClasspathEntry;
 import org.eclipse.jdt.core.ICompilationUnit;
 import org.eclipse.jdt.core.IField;
@@ -36,10 +38,12 @@
 import org.eclipse.jdt.core.IPackageFragmentRoot;
 import org.eclipse.jdt.core.ISourceReference;
 import org.eclipse.jdt.core.IType;
+import org.eclipse.jdt.core.ITypeRoot;
 import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.JavaModelException;
 import org.eclipse.jdt.core.Signature;
 import org.eclipse.jdt.core.SourceRange;
+import org.eclipse.jdt.core.compiler.CharOperation;
 
 import org.eclipse.jdt.internal.core.manipulation.util.BasicElementLabels;
 import org.eclipse.jdt.internal.corext.refactoring.RefactoringCoreMessages;
@@ -248,4 +252,32 @@ public static boolean isSourceAvailable(ISourceReference sourceReference) {
 			return false;
 		}
 	}
+
+	public static boolean isForbiddenOnClasspath(ITypeRoot root, String qualifiedTypeName) throws JavaModelException {
+		IJavaProject javaProject= root.getJavaProject();
+		if (javaProject != null) {
+			String qualifiedPathName= qualifiedTypeName.replace('.', '/');
+			IJavaElement type= javaProject.findElement(IPath.fromPortableString(qualifiedPathName).removeLastSegments(1));
+			while (type != null) {
+				IClasspathEntry entry= javaProject.getClasspathEntryFor(type.getPath());
+				if (entry != null) {
+					for (IAccessRule rule : entry.getAccessRules()) {
+						if (CharOperation.pathMatch(rule.getPattern().toString().toCharArray(), qualifiedPathName.toCharArray(),
+								true/*case sensitive*/, '/')) {
+							switch (rule.getKind()) {
+								case IAccessRule.K_NON_ACCESSIBLE:
+								case IAccessRule.K_DISCOURAGED:
+									return true;
+								default:
+									break;
+							}
+						}
+					}
+				}
+				type= type.getParent();
+			}
+		}
+		return false;
+	}
+
 }