| /******************************************************************************* |
| * Copyright (c) 2003, 2006 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| /* |
| * Created on Apr 30, 2004 |
| * |
| * To change the template for this generated file go to |
| * Window - Preferences - Java - Code Generation - Code and Comments |
| */ |
| package org.eclipse.jst.j2ee.internal.common.operations; |
| |
| |
| import java.util.Arrays; |
| import java.util.HashSet; |
| import java.util.Map; |
| |
| import org.eclipse.core.resources.IResource; |
| import org.eclipse.core.runtime.Assert; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IPath; |
| import org.eclipse.core.runtime.Path; |
| import org.eclipse.jdt.core.ClasspathContainerInitializer; |
| import org.eclipse.jdt.core.Flags; |
| import org.eclipse.jdt.core.IClassFile; |
| import org.eclipse.jdt.core.IClasspathContainer; |
| import org.eclipse.jdt.core.IClasspathEntry; |
| import org.eclipse.jdt.core.ICodeAssist; |
| import org.eclipse.jdt.core.ICompilationUnit; |
| import org.eclipse.jdt.core.IField; |
| import org.eclipse.jdt.core.IJavaElement; |
| import org.eclipse.jdt.core.IJavaProject; |
| import org.eclipse.jdt.core.IMember; |
| import org.eclipse.jdt.core.IMethod; |
| import org.eclipse.jdt.core.IOpenable; |
| import org.eclipse.jdt.core.IPackageFragment; |
| import org.eclipse.jdt.core.IPackageFragmentRoot; |
| import org.eclipse.jdt.core.IParent; |
| import org.eclipse.jdt.core.ISourceReference; |
| import org.eclipse.jdt.core.IType; |
| import org.eclipse.jdt.core.ITypeHierarchy; |
| import org.eclipse.jdt.core.JavaCore; |
| import org.eclipse.jdt.core.JavaModelException; |
| import org.eclipse.jdt.core.Signature; |
| import org.eclipse.jdt.core.WorkingCopyOwner; |
| import org.eclipse.jdt.core.compiler.CharOperation; |
| import org.eclipse.jdt.launching.IVMInstall; |
| import org.eclipse.jdt.launching.IVMInstall2; |
| import org.eclipse.jdt.launching.JavaRuntime; |
| |
| //TODO this is a copy of the class in org.eclipse.jdt.ui and should be deleted once bugzilla 60567 |
| // is addressed |
| /** |
| * |
| * @author jsholl |
| * |
| * To change the template for this generated type comment go to Window - Preferences - Java - Code |
| * Generation - Code and Comments |
| */ |
| /** |
| * Utility methods for the Java Model. |
| */ |
| public final class JavaModelUtil { |
| |
| /** |
| * Only use this suffix for creating new .java files. |
| * In general, use one of the three *JavaLike*(..) methods in JavaCore or create |
| * a name from an existing compilation unit with {@link #getRenamedCUName(ICompilationUnit, String)} |
| * <p> |
| * Note: Unlike {@link JavaCore#getJavaLikeExtensions()}, this suffix includes a leading ".". |
| * </p> |
| * |
| * @see JavaCore#getJavaLikeExtensions() |
| * @see JavaCore#isJavaLikeFileName(String) |
| * @see JavaCore#removeJavaLikeExtension(String) |
| * @see #getRenamedCUName(ICompilationUnit, String) |
| */ |
| public static final String DEFAULT_CU_SUFFIX= ".java"; //$NON-NLS-1$ |
| |
| /** |
| * Finds a type by its qualified type name (dot separated). |
| * @param jproject The java project to search in |
| * @param fullyQualifiedName The fully qualified name (type name with enclosing type names and package (all separated by dots)) |
| * @return The type found, or null if not existing |
| */ |
| public static IType findType(IJavaProject jproject, String fullyQualifiedName) throws JavaModelException { |
| //workaround for bug 22883 |
| IType type= jproject.findType(fullyQualifiedName); |
| if (type != null) |
| return type; |
| IPackageFragmentRoot[] roots= jproject.getPackageFragmentRoots(); |
| for (int i= 0; i < roots.length; i++) { |
| IPackageFragmentRoot root= roots[i]; |
| type= findType(root, fullyQualifiedName); |
| if (type != null && type.exists()) |
| return type; |
| } |
| return null; |
| } |
| |
| /** |
| * Finds a type by its qualified type name (dot separated). |
| * @param jproject The java project to search in |
| * @param fullyQualifiedName The fully qualified name (type name with enclosing type names and package (all separated by dots)) |
| * @param owner the working copy owner |
| * @return The type found, or null if not existing |
| */ |
| public static IType findType(IJavaProject jproject, String fullyQualifiedName, WorkingCopyOwner owner) throws JavaModelException { |
| //workaround for bug 22883 |
| IType type= jproject.findType(fullyQualifiedName, owner); |
| if (type != null) |
| return type; |
| IPackageFragmentRoot[] roots= jproject.getPackageFragmentRoots(); |
| for (int i= 0; i < roots.length; i++) { |
| IPackageFragmentRoot root= roots[i]; |
| type= findType(root, fullyQualifiedName); |
| if (type != null && type.exists()) |
| return type; |
| } |
| return null; |
| } |
| |
| |
| |
| private static IType findType(IPackageFragmentRoot root, String fullyQualifiedName) throws JavaModelException{ |
| IJavaElement[] children= root.getChildren(); |
| for (int i= 0; i < children.length; i++) { |
| IJavaElement element= children[i]; |
| if (element.getElementType() == IJavaElement.PACKAGE_FRAGMENT){ |
| IPackageFragment pack= (IPackageFragment)element; |
| if (! fullyQualifiedName.startsWith(pack.getElementName())) |
| continue; |
| IType type= findType(pack, fullyQualifiedName); |
| if (type != null && type.exists()) |
| return type; |
| } |
| } |
| return null; |
| } |
| |
| private static IType findType(IPackageFragment pack, String fullyQualifiedName) throws JavaModelException{ |
| ICompilationUnit[] cus= pack.getCompilationUnits(); |
| for (int i= 0; i < cus.length; i++) { |
| ICompilationUnit unit= cus[i]; |
| IType type= findType(unit, fullyQualifiedName); |
| if (type != null && type.exists()) |
| return type; |
| } |
| return null; |
| } |
| |
| private static IType findType(ICompilationUnit cu, String fullyQualifiedName) throws JavaModelException{ |
| IType[] types= cu.getAllTypes(); |
| for (int i= 0; i < types.length; i++) { |
| IType type= types[i]; |
| if (getFullyQualifiedName(type).equals(fullyQualifiedName)) |
| return type; |
| } |
| return null; |
| } |
| |
| /** |
| * Finds a type container by container name. |
| * The returned element will be of type <code>IType</code> or a <code>IPackageFragment</code>. |
| * <code>null</code> is returned if the type container could not be found. |
| * @param jproject The Java project defining the context to search |
| * @param typeContainerName A dot separated name of the type container |
| * @see #getTypeContainerName(IType) |
| */ |
| public static IJavaElement findTypeContainer(IJavaProject jproject, String typeContainerName) throws JavaModelException { |
| // try to find it as type |
| IJavaElement result= jproject.findType(typeContainerName); |
| if (result == null) { |
| // find it as package |
| IPath path= new Path(typeContainerName.replace('.', '/')); |
| result= jproject.findElement(path); |
| if (!(result instanceof IPackageFragment)) { |
| result= null; |
| } |
| |
| } |
| return result; |
| } |
| |
| /** |
| * Finds a type in a compilation unit. Typical usage is to find the corresponding |
| * type in a working copy. |
| * @param cu the compilation unit to search in |
| * @param typeQualifiedName the type qualified name (type name with enclosing type names (separated by dots)) |
| * @return the type found, or null if not existing |
| */ |
| public static IType findTypeInCompilationUnit(ICompilationUnit cu, String typeQualifiedName) throws JavaModelException { |
| IType[] types= cu.getAllTypes(); |
| for (int i= 0; i < types.length; i++) { |
| String currName= getTypeQualifiedName(types[i]); |
| if (typeQualifiedName.equals(currName)) { |
| return types[i]; |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * Returns the element of the given compilation unit which is "equal" to the |
| * given element. Note that the given element usually has a parent different |
| * from the given compilation unit. |
| * |
| * @param cu the cu to search in |
| * @param element the element to look for |
| * @return an element of the given cu "equal" to the given element |
| */ |
| public static IJavaElement findInCompilationUnit(ICompilationUnit cu, IJavaElement element) { |
| IJavaElement[] elements= cu.findElements(element); |
| if (elements != null && elements.length > 0) { |
| return elements[0]; |
| } |
| return null; |
| } |
| |
| /** |
| * Returns the qualified type name of the given type using '.' as separators. |
| * This is a replace for IType.getTypeQualifiedName() |
| * which uses '$' as separators. As '$' is also a valid character in an id |
| * this is ambiguous. JavaCore PR: 1GCFUNT |
| */ |
| public static String getTypeQualifiedName(IType type) { |
| try { |
| if (type.isBinary() && !type.isAnonymous()) { |
| IType declaringType= type.getDeclaringType(); |
| if (declaringType != null) { |
| return getTypeQualifiedName(declaringType) + '.' + type.getElementName(); |
| } |
| } |
| } catch (JavaModelException e) { |
| // ignore |
| } |
| return type.getTypeQualifiedName('.'); |
| } |
| |
| /** |
| * Returns the fully qualified name of the given type using '.' as separators. |
| * This is a replace for IType.getFullyQualifiedTypeName |
| * which uses '$' as separators. As '$' is also a valid character in an id |
| * this is ambiguous. JavaCore PR: 1GCFUNT |
| */ |
| public static String getFullyQualifiedName(IType type) { |
| try { |
| if (type.isBinary() && !type.isAnonymous()) { |
| IType declaringType= type.getDeclaringType(); |
| if (declaringType != null) { |
| return getFullyQualifiedName(declaringType) + '.' + type.getElementName(); |
| } |
| } |
| } catch (JavaModelException e) { |
| // ignore |
| } |
| return type.getFullyQualifiedName('.'); |
| } |
| |
| /** |
| * Returns the fully qualified name of a type's container. (package name or enclosing type name) |
| */ |
| public static String getTypeContainerName(IType type) { |
| IType outerType= type.getDeclaringType(); |
| if (outerType != null) { |
| return getFullyQualifiedName(outerType); |
| } |
| return type.getPackageFragment().getElementName(); |
| } |
| |
| |
| /** |
| * Concatenates two names. Uses a dot for separation. |
| * Both strings can be empty or <code>null</code>. |
| */ |
| public static String concatenateName(String name1, String name2) { |
| StringBuffer buf= new StringBuffer(); |
| if (name1 != null && name1.length() > 0) { |
| buf.append(name1); |
| } |
| if (name2 != null && name2.length() > 0) { |
| if (buf.length() > 0) { |
| buf.append('.'); |
| } |
| buf.append(name2); |
| } |
| return buf.toString(); |
| } |
| |
| /** |
| * Concatenates two names. Uses a dot for separation. |
| * Both strings can be empty or <code>null</code>. |
| */ |
| public static String concatenateName(char[] name1, char[] name2) { |
| StringBuffer buf= new StringBuffer(); |
| if (name1 != null && name1.length > 0) { |
| buf.append(name1); |
| } |
| if (name2 != null && name2.length > 0) { |
| if (buf.length() > 0) { |
| buf.append('.'); |
| } |
| buf.append(name2); |
| } |
| return buf.toString(); |
| } |
| |
| /** |
| * Evaluates if a member (possible from another package) is visible from |
| * elements in a package. |
| * @param member The member to test the visibility for |
| * @param pack The package in focus |
| */ |
| public static boolean isVisible(IMember member, IPackageFragment pack) throws JavaModelException { |
| |
| int type= member.getElementType(); |
| if (type == IJavaElement.INITIALIZER || (type == IJavaElement.METHOD && member.getElementName().startsWith("<"))) { //$NON-NLS-1$ |
| return false; |
| } |
| |
| int otherflags= member.getFlags(); |
| IType declaringType= member.getDeclaringType(); |
| if (Flags.isPublic(otherflags) || (declaringType != null && isInterfaceOrAnnotation(declaringType))) { |
| return true; |
| } else if (Flags.isPrivate(otherflags)) { |
| return false; |
| } |
| |
| IPackageFragment otherpack= (IPackageFragment) member.getAncestor(IJavaElement.PACKAGE_FRAGMENT); |
| return (pack != null && otherpack != null && isSamePackage(pack, otherpack)); |
| } |
| |
| /** |
| * Evaluates if a member in the focus' element hierarchy is visible from |
| * elements in a package. |
| * @param member The member to test the visibility for |
| * @param pack The package of the focus element focus |
| */ |
| public static boolean isVisibleInHierarchy(IMember member, IPackageFragment pack) throws JavaModelException { |
| int type= member.getElementType(); |
| if (type == IJavaElement.INITIALIZER || (type == IJavaElement.METHOD && member.getElementName().startsWith("<"))) { //$NON-NLS-1$ |
| return false; |
| } |
| |
| int otherflags= member.getFlags(); |
| |
| IType declaringType= member.getDeclaringType(); |
| if (Flags.isPublic(otherflags) || Flags.isProtected(otherflags) || (declaringType != null && isInterfaceOrAnnotation(declaringType))) { |
| return true; |
| } else if (Flags.isPrivate(otherflags)) { |
| return false; |
| } |
| |
| IPackageFragment otherpack= (IPackageFragment) member.getAncestor(IJavaElement.PACKAGE_FRAGMENT); |
| return (pack != null && pack.equals(otherpack)); |
| } |
| |
| |
| /** |
| * Returns the package fragment root of <code>IJavaElement</code>. If the given |
| * element is already a package fragment root, the element itself is returned. |
| */ |
| public static IPackageFragmentRoot getPackageFragmentRoot(IJavaElement element) { |
| return (IPackageFragmentRoot) element.getAncestor(IJavaElement.PACKAGE_FRAGMENT_ROOT); |
| } |
| |
| /** |
| * Finds a method in a type. |
| * This searches for a method with the same name and signature. Parameter types are only |
| * compared by the simple name, no resolving for the fully qualified type name is done. |
| * Constructors are only compared by parameters, not the name. |
| * @param name The name of the method to find |
| * @param paramTypes The type signatures of the parameters e.g. <code>{"QString;","I"}</code> |
| * @param isConstructor If the method is a constructor |
| * @return The first found method or <code>null</code>, if nothing found |
| */ |
| public static IMethod findMethod(String name, String[] paramTypes, boolean isConstructor, IType type) throws JavaModelException { |
| IMethod[] methods= type.getMethods(); |
| for (int i= 0; i < methods.length; i++) { |
| if (isSameMethodSignature(name, paramTypes, isConstructor, methods[i])) { |
| return methods[i]; |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * @deprecated use {@link #findMethodInHierarchy(ITypeHierarchy, IType, String, String[], boolean)} |
| */ |
| public static IMethod findMethodImplementationInHierarchy(ITypeHierarchy hierarchy, IType type, String name, String[] paramTypes, boolean isConstructor) throws JavaModelException { |
| return findMethodInHierarchy(hierarchy, type, name, paramTypes, isConstructor); |
| } |
| |
| /** |
| * Finds a method in a type and all its super types. The super class hierarchy is searched first, then the super interfaces. |
| * This searches for a method with the same name and signature. Parameter types are only |
| * compared by the simple name, no resolving for the fully qualified type name is done. |
| * Constructors are only compared by parameters, not the name. |
| * NOTE: For finding overridden methods or for finding the declaring method, use {@link MethodOverrideTester} |
| * @param hierarchy The hierarchy containing the type |
| * @param type The type to start the search from |
| * @param name The name of the method to find |
| * @param paramTypes The type signatures of the parameters e.g. <code>{"QString;","I"}</code> |
| * @param isConstructor If the method is a constructor |
| * @return The first found method or <code>null</code>, if nothing found |
| */ |
| public static IMethod findMethodInHierarchy(ITypeHierarchy hierarchy, IType type, String name, String[] paramTypes, boolean isConstructor) throws JavaModelException { |
| IMethod method= findMethod(name, paramTypes, isConstructor, type); |
| if (method != null) { |
| return method; |
| } |
| IType superClass= hierarchy.getSuperclass(type); |
| if (superClass != null) { |
| IMethod res= findMethodInHierarchy(hierarchy, superClass, name, paramTypes, isConstructor); |
| if (res != null) { |
| return res; |
| } |
| } |
| if (!isConstructor) { |
| IType[] superInterfaces= hierarchy.getSuperInterfaces(type); |
| for (int i= 0; i < superInterfaces.length; i++) { |
| IMethod res= findMethodInHierarchy(hierarchy, superInterfaces[i], name, paramTypes, false); |
| if (res != null) { |
| return res; |
| } |
| } |
| } |
| return method; |
| } |
| |
| |
| /** |
| * Tests if a method equals to the given signature. |
| * Parameter types are only compared by the simple name, no resolving for |
| * the fully qualified type name is done. Constructors are only compared by |
| * parameters, not the name. |
| * @param name Name of the method |
| * @param paramTypes The type signatures of the parameters e.g. <code>{"QString;","I"}</code> |
| * @param isConstructor Specifies if the method is a constructor |
| * @return Returns <code>true</code> if the method has the given name and parameter types and constructor state. |
| */ |
| public static boolean isSameMethodSignature(String name, String[] paramTypes, boolean isConstructor, IMethod curr) throws JavaModelException { |
| if (isConstructor || name.equals(curr.getElementName())) { |
| if (isConstructor == curr.isConstructor()) { |
| String[] currParamTypes= curr.getParameterTypes(); |
| if (paramTypes.length == currParamTypes.length) { |
| for (int i= 0; i < paramTypes.length; i++) { |
| String t1= Signature.getSimpleName(Signature.toString(paramTypes[i])); |
| String t2= Signature.getSimpleName(Signature.toString(currParamTypes[i])); |
| if (!t1.equals(t2)) { |
| return false; |
| } |
| } |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Tests if two <code>IPackageFragment</code>s represent the same logical java package. |
| * @return <code>true</code> if the package fragments' names are equal. |
| */ |
| public static boolean isSamePackage(IPackageFragment pack1, IPackageFragment pack2) { |
| return pack1.getElementName().equals(pack2.getElementName()); |
| } |
| |
| /** |
| * Checks whether the given type has a valid main method or not. |
| */ |
| public static boolean hasMainMethod(IType type) throws JavaModelException { |
| IMethod[] methods= type.getMethods(); |
| for (int i= 0; i < methods.length; i++) { |
| if (methods[i].isMainMethod()) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Checks if the field is boolean. |
| */ |
| public static boolean isBoolean(IField field) throws JavaModelException{ |
| return field.getTypeSignature().equals(Signature.SIG_BOOLEAN); |
| } |
| |
| /** |
| * @return <code>true</code> iff the type is an interface or an annotation |
| */ |
| public static boolean isInterfaceOrAnnotation(IType type) throws JavaModelException { |
| return type.isInterface(); |
| } |
| |
| /** |
| * Resolves a type name in the context of the declaring type. |
| * |
| * @param refTypeSig the type name in signature notation (for example 'QVector') this can also be an array type, but dimensions will be ignored. |
| * @param declaringType the context for resolving (type where the reference was made in) |
| * @return returns the fully qualified type name or build-in-type name. if a unresolved type couldn't be resolved null is returned |
| */ |
| public static String getResolvedTypeName(String refTypeSig, IType declaringType) throws JavaModelException { |
| int arrayCount= Signature.getArrayCount(refTypeSig); |
| char type= refTypeSig.charAt(arrayCount); |
| if (type == Signature.C_UNRESOLVED) { |
| String name= ""; //$NON-NLS-1$ |
| int bracket= refTypeSig.indexOf(Signature.C_GENERIC_START, arrayCount + 1); |
| if (bracket > 0) |
| name= refTypeSig.substring(arrayCount + 1, bracket); |
| else { |
| int semi= refTypeSig.indexOf(Signature.C_SEMICOLON, arrayCount + 1); |
| if (semi == -1) { |
| throw new IllegalArgumentException(); |
| } |
| name= refTypeSig.substring(arrayCount + 1, semi); |
| } |
| String[][] resolvedNames= declaringType.resolveType(name); |
| if (resolvedNames != null && resolvedNames.length > 0) { |
| return JavaModelUtil.concatenateName(resolvedNames[0][0], resolvedNames[0][1]); |
| } |
| return null; |
| } |
| return Signature.toString(refTypeSig.substring(arrayCount)); |
| } |
| |
| /** |
| * Returns if a CU can be edited. |
| */ |
| public static boolean isEditable(ICompilationUnit cu) { |
| Assert.isNotNull(cu); |
| IResource resource= cu.getPrimary().getResource(); |
| return (resource.exists() && !resource.getResourceAttributes().isReadOnly()); |
| } |
| |
| /** |
| * Returns the original if the given member. If the member is already |
| * an original the input is returned. The returned member might not exist |
| * |
| * @deprecated Replace by IMember#getPrimaryElement() if <code>member</code> is not part |
| * of a shared working copy owner. Also have a look at http://bugs.eclipse.org/bugs/show_bug.cgi?id=18568 |
| */ |
| public static IMember toOriginal(IMember member) { |
| if (member instanceof IMethod) |
| return toOriginalMethod((IMethod)member); |
| |
| // TODO: remove toOriginalMethod(IMethod) |
| |
| return (IMember) member.getPrimaryElement(); |
| /*ICompilationUnit cu= member.getCompilationUnit(); |
| if (cu != null && cu.isWorkingCopy()) |
| return (IMember)cu.getOriginal(member); |
| return member;*/ |
| } |
| |
| /* |
| * TODO remove if toOriginal(IMember) can be removed |
| * XXX workaround for bug 18568 |
| * http://bugs.eclipse.org/bugs/show_bug.cgi?id=18568 |
| * to be removed once the bug is fixed |
| */ |
| private static IMethod toOriginalMethod(IMethod method) { |
| ICompilationUnit cu= method.getCompilationUnit(); |
| if (cu == null || isPrimary(cu)) { |
| return method; |
| } |
| try{ |
| //use the workaround only if needed |
| if (! method.getElementName().equals(method.getDeclaringType().getElementName())) |
| return (IMethod) method.getPrimaryElement(); |
| |
| IType originalType = (IType) toOriginal(method.getDeclaringType()); |
| IMethod[] methods = originalType.findMethods(method); |
| boolean isConstructor = method.isConstructor(); |
| for (int i=0; i < methods.length; i++) { |
| if (methods[i].isConstructor() == isConstructor) |
| return methods[i]; |
| } |
| return null; |
| } catch (JavaModelException e){ |
| return null; |
| } |
| } |
| |
| /** |
| * Returns true if a cu is a primary cu (original or shared working copy) |
| */ |
| public static boolean isPrimary(ICompilationUnit cu) { |
| return cu.getOwner() == null; |
| } |
| |
| /* |
| * http://bugs.eclipse.org/bugs/show_bug.cgi?id=19253 |
| * |
| * Reconciling happens in a separate thread. This can cause a situation where the |
| * Java element gets disposed after an exists test has been done. So we should not |
| * log not present exceptions when they happen in working copies. |
| */ |
| public static boolean isExceptionToBeLogged(CoreException exception) { |
| if (!(exception instanceof JavaModelException)) |
| return true; |
| JavaModelException je= (JavaModelException)exception; |
| if (!je.isDoesNotExist()) |
| return true; |
| IJavaElement[] elements= je.getJavaModelStatus().getElements(); |
| for (int i= 0; i < elements.length; i++) { |
| IJavaElement element= elements[i]; |
| // if the element is already a compilation unit don't log |
| // does not exist exceptions. See bug |
| // https://bugs.eclipse.org/bugs/show_bug.cgi?id=75894 |
| // for more details |
| if (element.getElementType() == IJavaElement.COMPILATION_UNIT) |
| continue; |
| ICompilationUnit unit= (ICompilationUnit)element.getAncestor(IJavaElement.COMPILATION_UNIT); |
| if (unit == null) |
| return true; |
| if (!unit.isWorkingCopy()) |
| return true; |
| } |
| return false; |
| } |
| |
| public static boolean isSuperType(ITypeHierarchy hierarchy, IType possibleSuperType, IType type) { |
| // filed bug 112635 to add this method to ITypeHierarchy |
| IType superClass= hierarchy.getSuperclass(type); |
| if (superClass != null && (possibleSuperType.equals(superClass) || isSuperType(hierarchy, possibleSuperType, superClass))) { |
| return true; |
| } |
| if (Flags.isInterface(hierarchy.getCachedFlags(possibleSuperType))) { |
| IType[] superInterfaces= hierarchy.getSuperInterfaces(type); |
| for (int i= 0; i < superInterfaces.length; i++) { |
| IType curr= superInterfaces[i]; |
| if (possibleSuperType.equals(curr) || isSuperType(hierarchy, possibleSuperType, curr)) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| public static boolean isExcludedPath(IPath resourcePath, IPath[] exclusionPatterns) { |
| char[] path = resourcePath.toString().toCharArray(); |
| for (int i = 0, length = exclusionPatterns.length; i < length; i++) { |
| char[] pattern= exclusionPatterns[i].toString().toCharArray(); |
| if (CharOperation.pathMatch(pattern, path, true, '/')) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| |
| /* |
| * Returns whether the given resource path matches one of the exclusion |
| * patterns. |
| * |
| * @see IClasspathEntry#getExclusionPatterns |
| */ |
| public final static boolean isExcluded(IPath resourcePath, char[][] exclusionPatterns) { |
| if (exclusionPatterns == null) return false; |
| char[] path = resourcePath.toString().toCharArray(); |
| for (int i = 0, length = exclusionPatterns.length; i < length; i++) |
| if (CharOperation.pathMatch(exclusionPatterns[i], path, true, '/')) |
| return true; |
| return false; |
| } |
| |
| |
| /** |
| * Force a reconcile of a compilation unit. |
| * @param unit |
| */ |
| public static void reconcile(ICompilationUnit unit) throws JavaModelException { |
| unit.reconcile( |
| ICompilationUnit.NO_AST, |
| false /* don't force problem detection */, |
| null /* use primary owner */, |
| null /* no progress monitor */); |
| } |
| |
| /** |
| * Helper method that tests if an classpath entry can be found in a |
| * container. <code>null</code> is returned if the entry can not be found |
| * or if the container does not allows the configuration of source |
| * attachments |
| * @param jproject The container's parent project |
| * @param containerPath The path of the container |
| * @param libPath The path of the library to be found |
| * @return IClasspathEntry A classpath entry from the container of |
| * <code>null</code> if the container can not be modified. |
| */ |
| public static IClasspathEntry getClasspathEntryToEdit(IJavaProject jproject, IPath containerPath, IPath libPath) throws JavaModelException { |
| IClasspathContainer container= JavaCore.getClasspathContainer(containerPath, jproject); |
| ClasspathContainerInitializer initializer= JavaCore.getClasspathContainerInitializer(containerPath.segment(0)); |
| if (container != null && initializer != null && initializer.canUpdateClasspathContainer(containerPath, jproject)) { |
| IClasspathEntry[] entries= container.getClasspathEntries(); |
| for (int i= 0; i < entries.length; i++) { |
| IClasspathEntry curr= entries[i]; |
| IClasspathEntry resolved= JavaCore.getResolvedClasspathEntry(curr); |
| if (resolved != null && libPath.equals(resolved.getPath())) { |
| return curr; // return the real entry |
| } |
| } |
| } |
| return null; // attachment not possible |
| } |
| |
| /** |
| * Get all compilation units of a selection. |
| * @param javaElements the selected java elements |
| * @return all compilation units containing and contained in elements from javaElements |
| * @throws JavaModelException |
| */ |
| public static ICompilationUnit[] getAllCompilationUnits(IJavaElement[] javaElements) throws JavaModelException { |
| HashSet result= new HashSet(); |
| for (int i= 0; i < javaElements.length; i++) { |
| addAllCus(result, javaElements[i]); |
| } |
| return (ICompilationUnit[]) result.toArray(new ICompilationUnit[result.size()]); |
| } |
| |
| private static void addAllCus(HashSet/*<ICompilationUnit>*/ collector, IJavaElement javaElement) throws JavaModelException { |
| switch (javaElement.getElementType()) { |
| case IJavaElement.JAVA_PROJECT: |
| IJavaProject javaProject= (IJavaProject) javaElement; |
| IPackageFragmentRoot[] packageFragmentRoots= javaProject.getPackageFragmentRoots(); |
| for (int i= 0; i < packageFragmentRoots.length; i++) |
| addAllCus(collector, packageFragmentRoots[i]); |
| return; |
| |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| IPackageFragmentRoot packageFragmentRoot= (IPackageFragmentRoot) javaElement; |
| if (packageFragmentRoot.getKind() != IPackageFragmentRoot.K_SOURCE) |
| return; |
| IJavaElement[] packageFragments= packageFragmentRoot.getChildren(); |
| for (int j= 0; j < packageFragments.length; j++) |
| addAllCus(collector, packageFragments[j]); |
| return; |
| |
| case IJavaElement.PACKAGE_FRAGMENT: |
| IPackageFragment packageFragment= (IPackageFragment) javaElement; |
| collector.addAll(Arrays.asList(packageFragment.getCompilationUnits())); |
| return; |
| |
| case IJavaElement.COMPILATION_UNIT: |
| collector.add(javaElement); |
| return; |
| |
| default: |
| IJavaElement cu= javaElement.getAncestor(IJavaElement.COMPILATION_UNIT); |
| if (cu != null) |
| collector.add(cu); |
| } |
| } |
| |
| |
| /** |
| * Sets all compliance settings in the given map to 5.0 |
| */ |
| public static void set50CompilanceOptions(Map map) { |
| setCompilanceOptions(map, JavaCore.VERSION_1_5); |
| } |
| |
| public static void setCompilanceOptions(Map map, String compliance) { |
| if (JavaCore.VERSION_1_6.equals(compliance)) { |
| map.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_6); |
| map.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_6); |
| map.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_6); |
| map.put(JavaCore.COMPILER_PB_ASSERT_IDENTIFIER, JavaCore.ERROR); |
| map.put(JavaCore.COMPILER_PB_ENUM_IDENTIFIER, JavaCore.ERROR); |
| } else if (JavaCore.VERSION_1_5.equals(compliance)) { |
| map.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_5); |
| map.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_5); |
| map.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_5); |
| map.put(JavaCore.COMPILER_PB_ASSERT_IDENTIFIER, JavaCore.ERROR); |
| map.put(JavaCore.COMPILER_PB_ENUM_IDENTIFIER, JavaCore.ERROR); |
| } else if (JavaCore.VERSION_1_4.equals(compliance)) { |
| map.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_4); |
| map.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_3); |
| map.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_2); |
| map.put(JavaCore.COMPILER_PB_ASSERT_IDENTIFIER, JavaCore.WARNING); |
| map.put(JavaCore.COMPILER_PB_ENUM_IDENTIFIER, JavaCore.WARNING); |
| } else if (JavaCore.VERSION_1_3.equals(compliance)) { |
| map.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_3); |
| map.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_3); |
| map.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_1); |
| map.put(JavaCore.COMPILER_PB_ASSERT_IDENTIFIER, JavaCore.IGNORE); |
| map.put(JavaCore.COMPILER_PB_ENUM_IDENTIFIER, JavaCore.IGNORE); |
| } else { |
| throw new IllegalArgumentException("Unsupported compliance: " + compliance); //$NON-NLS-1$ |
| } |
| } |
| |
| /** |
| * @return returns if version 1 is less than version 2. |
| */ |
| public static boolean isVersionLessThan(String version1, String version2) { |
| return version1.compareTo(version2) < 0; |
| } |
| |
| public static boolean is50OrHigher(String compliance) { |
| return !isVersionLessThan(compliance, JavaCore.VERSION_1_5); |
| } |
| |
| public static boolean is50OrHigher(IJavaProject project) { |
| return is50OrHigher(project.getOption(JavaCore.COMPILER_COMPLIANCE, true)); |
| } |
| |
| public static boolean is50OrHigherJRE(IJavaProject project) throws CoreException { |
| IVMInstall vmInstall= JavaRuntime.getVMInstall(project); |
| if (!(vmInstall instanceof IVMInstall2)) |
| return true; // assume 5.0. |
| |
| String compliance= getCompilerCompliance((IVMInstall2) vmInstall, null); |
| if (compliance == null) |
| return true; // assume 5.0 |
| return compliance.startsWith(JavaCore.VERSION_1_5) || compliance.startsWith(JavaCore.VERSION_1_6); |
| } |
| |
| public static String getCompilerCompliance(IVMInstall2 vMInstall, String defaultCompliance) { |
| String version= vMInstall.getJavaVersion(); |
| if (version == null) { |
| return defaultCompliance; |
| } else if (version.startsWith(JavaCore.VERSION_1_6)) { |
| return JavaCore.VERSION_1_6; |
| } else if (version.startsWith(JavaCore.VERSION_1_5)) { |
| return JavaCore.VERSION_1_5; |
| } else if (version.startsWith(JavaCore.VERSION_1_4)) { |
| return JavaCore.VERSION_1_4; |
| } else if (version.startsWith(JavaCore.VERSION_1_3)) { |
| return JavaCore.VERSION_1_3; |
| } else if (version.startsWith(JavaCore.VERSION_1_2)) { |
| return JavaCore.VERSION_1_3; |
| } else if (version.startsWith(JavaCore.VERSION_1_1)) { |
| return JavaCore.VERSION_1_3; |
| } |
| return defaultCompliance; |
| } |
| |
| /** |
| * Compute a new name for a compilation unit, given the name of the new main type. |
| * This query tries to maintain the existing extension (e.g. ".java"). |
| * |
| * @param cu a compilation unit |
| * @param newMainName the new name of the cu's main type (without extension) |
| * @return the new name for the compilation unit |
| */ |
| public static String getRenamedCUName(ICompilationUnit cu, String newMainName) { |
| String oldName = cu.getElementName(); |
| int i = oldName.lastIndexOf('.'); |
| if (i != -1) { |
| return newMainName + oldName.substring(i); |
| } |
| return newMainName; |
| } |
| |
| public static boolean isImplicitImport(String qualifier, ICompilationUnit cu) { |
| if ("java.lang".equals(qualifier)) { //$NON-NLS-1$ |
| return true; |
| } |
| String packageName= cu.getParent().getElementName(); |
| if (qualifier.equals(packageName)) { |
| return true; |
| } |
| String typeName= JavaCore.removeJavaLikeExtension(cu.getElementName()); |
| String mainTypeName= JavaModelUtil.concatenateName(packageName, typeName); |
| return qualifier.equals(mainTypeName); |
| } |
| |
| /** |
| * If <code>true</code>, then element can safely be cast to any of |
| * {@link IParent}, {@link IOpenable}, {@link ISourceReference}, or {@link ICodeAssist}. |
| * @param element |
| * @return <code>true</code> iff element is an {@link ICompilationUnit} or an {@link IClassFile} |
| */ |
| public static boolean isTypeContainerUnit(IJavaElement element) { |
| // workaround for https://bugs.eclipse.org/bugs/show_bug.cgi?id=125504 |
| return element instanceof ICompilationUnit || element instanceof IClassFile; |
| } |
| |
| public static IJavaElement getTypeContainerUnit(IMember member) { |
| ICompilationUnit cu= member.getCompilationUnit(); |
| if (cu != null) |
| return cu; |
| return member.getClassFile(); |
| } |
| } |
