blob: c384ca7a0ec1d3db0e2f7fcb1ab63871b6e59881 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2017, 2018 GK Software SE, 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:
* Stephan Herrmann - initial API and implementation
*******************************************************************************/
package org.aspectj.org.eclipse.jdt.core.provisional;
import org.aspectj.org.eclipse.jdt.core.IJavaElement;
import org.aspectj.org.eclipse.jdt.core.IModuleDescription;
import org.aspectj.org.eclipse.jdt.core.JavaModelException;
import org.aspectj.org.eclipse.jdt.internal.core.JavaProject;
import org.aspectj.org.eclipse.jdt.internal.core.PackageFragmentRoot;
/**
* Provisional API for use by JDT/UI or JDT/Debug, which may possibly be removed in a future version.
* See <a href="https://bugs.eclipse.org/522391">Bug 522391</a>.
*/
public class JavaModelAccess {
/**
* Answer the names of all modules directly required from the given module.
* @param module the module whose "requires" directives are queried
* @return a non-null array of module names
* @deprecated this provisional API has been promoted to {@link IModuleDescription#getRequiredModuleNames()}
*/
@Deprecated
public static String[] getRequiredModules(IModuleDescription module) throws JavaModelException {
return module.getRequiredModuleNames();
}
/**
* Returns the <code>IModuleDescription</code> that the given java element contains
* when regarded as an automatic module. The element must be an <code>IPackageFragmentRoot</code>
* or an <code>IJavaProject</code>.
*
* <p>The returned module descriptor has a name (<code>getElementName()</code>) following
* the specification of <code>java.lang.module.ModuleFinder.of(Path...)</code>, but it
* contains no other useful information.</p>
*
* @return the <code>IModuleDescription</code> representing this java element as an automatic module,
* never <code>null</code>.
* @throws JavaModelException
* @throws IllegalArgumentException if the provided element is neither <code>IPackageFragmentRoot</code>
* nor <code>IJavaProject</code>
* @since 3.14
*/
public static IModuleDescription getAutomaticModuleDescription(IJavaElement element) throws JavaModelException, IllegalArgumentException {
switch (element.getElementType()) {
case IJavaElement.JAVA_PROJECT:
return ((JavaProject) element).getAutomaticModuleDescription();
case IJavaElement.PACKAGE_FRAGMENT_ROOT:
return ((PackageFragmentRoot) element).getAutomaticModuleDescription();
default:
throw new IllegalArgumentException("Illegal kind of java element: "+element.getElementType()); //$NON-NLS-1$
}
}
}