Java tutorial
/******************************************************************************* * Copyright (c) 2000, 2011 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 * Brock Janiczak <brockj@tpg.com.au> - bug 201044 * Gary Duprex <Gary.Duprex@aspectstools.com> - bug 179213 * Benjamin Cabe <benjamin.cabe@anyware-tech.com> - bug 247553 *******************************************************************************/ package com.siteview.mde.internal.ui.wizards.plugin; import com.siteview.mde.internal.core.monitor.*; import com.siteview.mde.core.monitor.*; import java.lang.reflect.InvocationTargetException; import java.util.*; import org.eclipse.core.resources.*; import org.eclipse.core.runtime.*; import org.eclipse.core.runtime.preferences.IEclipsePreferences; import org.eclipse.jdt.core.*; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.StructuredSelection; import com.siteview.mde.core.build.IBuildEntry; import com.siteview.mde.core.build.IBuildModelFactory; import com.siteview.mde.internal.core.*; import com.siteview.mde.internal.core.build.WorkspaceBuildModel; import com.siteview.mde.internal.core.bundle.*; import com.siteview.mde.internal.core.ibundle.*; import com.siteview.mde.internal.core.natures.MDE; import com.siteview.mde.internal.core.project.PDEProject; import com.siteview.mde.internal.core.util.CoreUtility; import com.siteview.mde.internal.ui.MDEPlugin; import com.siteview.mde.internal.ui.MDEUIMessages; import com.siteview.mde.internal.ui.wizards.IProjectProvider; import com.siteview.mde.ui.*; import org.eclipse.ui.*; import org.eclipse.ui.actions.WorkspaceModifyOperation; import org.eclipse.ui.ide.IDE; import org.eclipse.ui.part.ISetSelectionTarget; import org.osgi.framework.Constants; import org.osgi.service.prefs.BackingStoreException; public class NewProjectCreationOperation extends WorkspaceModifyOperation { private IPluginContentWizard fContentWizard; private IFieldData fData; private PluginClassCodeGenerator fGenerator; private WorkspaceMonitorModelBase fModel; private IProjectProvider fProjectProvider; private boolean fResult; /** * @param data * @param provider representation of the project * @param contentWizard wizard to run to get details for the chosen template, may be <code>null</code> if a template is not being used */ public NewProjectCreationOperation(IFieldData data, IProjectProvider provider, IPluginContentWizard contentWizard) { fData = data; fProjectProvider = provider; fContentWizard = contentWizard; } // function used to modify Manifest just before it is written out (after all project artifacts have been created. protected void adjustManifests(IProgressMonitor monitor, IProject project, IMonitorBase bundle) throws CoreException { // if libraries are exported, compute export package (173393) IMonitorLibrary[] libs = fModel.getMonitorBase().getLibraries(); Set packages = new TreeSet(); for (int i = 0; i < libs.length; i++) { String[] filters = libs[i].getContentFilters(); // if a library is fully exported, then export all source packages (since we don't know which source folders go with which library) if (filters.length == 1 && filters[0].equals("**")) { //$NON-NLS-1$ addAllSourcePackages(project, packages); break; } for (int j = 0; j < filters.length; j++) { if (filters[j].endsWith(".*")) //$NON-NLS-1$ packages.add(filters[j].substring(0, filters[j].length() - 2)); } } if (!packages.isEmpty()) { IBundle iBundle = ((WorkspaceBundlePluginModelBase) fModel).getBundleModel().getBundle(); iBundle.setHeader(Constants.EXPORT_PACKAGE, getCommaValuesFromPackagesSet(packages, fData.getVersion())); } } private void createBuildPropertiesFile(IProject project) throws CoreException { IFile file = PDEProject.getBuildProperties(project); if (!file.exists()) { WorkspaceBuildModel model = new WorkspaceBuildModel(file); IBuildModelFactory factory = model.getFactory(); // BIN.INCLUDES IBuildEntry binEntry = factory.createEntry(IBuildEntry.BIN_INCLUDES); fillBinIncludes(project, binEntry); createSourceOutputBuildEntries(model, factory); model.getBuild().add(binEntry); model.save(); } } protected void createSourceOutputBuildEntries(WorkspaceBuildModel model, IBuildModelFactory factory) throws CoreException { String srcFolder = fData.getSourceFolderName(); if (!fData.isSimple() && srcFolder != null) { String libraryName = fData.getLibraryName(); if (libraryName == null) libraryName = "."; //$NON-NLS-1$ // SOURCE.<LIBRARY_NAME> IBuildEntry entry = factory.createEntry(IBuildEntry.JAR_PREFIX + libraryName); if (srcFolder.length() > 0) entry.addToken(new Path(srcFolder).addTrailingSeparator().toString()); else entry.addToken("."); //$NON-NLS-1$ model.getBuild().add(entry); // OUTPUT.<LIBRARY_NAME> entry = factory.createEntry(IBuildEntry.OUTPUT_PREFIX + libraryName); String outputFolder = fData.getOutputFolderName().trim(); if (outputFolder.length() > 0) entry.addToken(new Path(outputFolder).addTrailingSeparator().toString()); else entry.addToken("."); //$NON-NLS-1$ model.getBuild().add(entry); } } protected void createContents(IProgressMonitor monitor, IProject project) throws CoreException, JavaModelException, InvocationTargetException, InterruptedException { } private void createManifest(IProject project) throws CoreException { IFile fragmentXml = PDEProject.getFragmentXml(project); IFile pluginXml = PDEProject.getPluginXml(project); if (fData.hasBundleStructure()) { IFile manifest = PDEProject.getManifest(project); if (fData instanceof IFragmentFieldData) { fModel = new WorkspaceBundleFragmentModel(manifest, fragmentXml); } else { fModel = new WorkspaceBundlePluginModel(manifest, pluginXml); } } else { if (fData instanceof IFragmentFieldData) { fModel = new WorkspaceFragmentModel(fragmentXml, false); } else { fModel = new WorkspaceMonitorModel(pluginXml, false); } } IMonitorBase pluginBase = fModel.getMonitorBase(); String targetVersion = ((AbstractFieldData) fData).getTargetVersion(); pluginBase.setSchemaVersion(TargetPlatformHelper.getSchemaVersionForTargetVersion(targetVersion)); pluginBase.setId(fData.getId()); pluginBase.setVersion(fData.getVersion()); pluginBase.setName(fData.getName()); pluginBase.setProviderName(fData.getProvider()); if (fModel instanceof IBundlePluginModelBase) { IBundlePluginModelBase bmodel = ((IBundlePluginModelBase) fModel); ((IBundlePluginBase) bmodel.getMonitorBase()).setTargetVersion(targetVersion); bmodel.getBundleModel().getBundle().setHeader(Constants.BUNDLE_MANIFESTVERSION, "2"); //$NON-NLS-1$ } if (pluginBase instanceof IFragment) { IFragment fragment = (IFragment) pluginBase; IFragmentFieldData data = (IFragmentFieldData) fData; fragment.setPluginId(data.getPluginId()); fragment.setPluginVersion(data.getPluginVersion()); fragment.setRule(data.getMatch()); } else { if (((IPluginFieldData) fData).doGenerateClass()) ((IMonitor) pluginBase).setClassName(((IPluginFieldData) fData).getClassname()); } if (!fData.isSimple()) { setPluginLibraries(fModel); } IMonitorReference[] dependencies = getDependencies(); for (int i = 0; i < dependencies.length; i++) { IMonitorReference ref = dependencies[i]; IMonitorImport iimport = fModel.getMonitorFactory().createImport(); iimport.setId(ref.getId()); iimport.setVersion(ref.getVersion()); iimport.setMatch(ref.getMatch()); pluginBase.add(iimport); } // add Bundle Specific fields if applicable if (pluginBase instanceof BundlePluginBase) { IBundle bundle = ((BundlePluginBase) pluginBase).getBundle(); if (fData instanceof AbstractFieldData) { // Set required EE String exeEnvironment = ((AbstractFieldData) fData).getExecutionEnvironment(); if (exeEnvironment != null) { bundle.setHeader(Constants.BUNDLE_REQUIREDEXECUTIONENVIRONMENT, exeEnvironment); } String framework = ((AbstractFieldData) fData).getOSGiFramework(); if (framework != null) { String value = getCommaValuesFromPackagesSet(getImportPackagesSet(), fData.getVersion()); if (value.length() > 0) bundle.setHeader(Constants.IMPORT_PACKAGE, value); // if framework is not equinox, skip equinox step below to add extra headers if (!framework.equals(ICoreConstants.EQUINOX)) return; } } if (fData instanceof IPluginFieldData && ((IPluginFieldData) fData).doGenerateClass()) { if (targetVersion.equals("3.1")) //$NON-NLS-1$ bundle.setHeader(ICoreConstants.ECLIPSE_AUTOSTART, "true"); //$NON-NLS-1$ else { double version = Double.parseDouble(targetVersion); if (version >= 3.4) { bundle.setHeader(Constants.BUNDLE_ACTIVATIONPOLICY, Constants.ACTIVATION_LAZY); } else { bundle.setHeader(ICoreConstants.ECLIPSE_LAZYSTART, "true"); //$NON-NLS-1$ } } } if (fContentWizard != null) { String[] newFiles = fContentWizard.getNewFiles(); if (newFiles != null) for (int i = 0; i < newFiles.length; i++) { if ("plugin.properties".equals(newFiles[i])) { //$NON-NLS-1$ bundle.setHeader(Constants.BUNDLE_LOCALIZATION, "plugin"); //$NON-NLS-1$ break; } } } } } private IProject createProject() throws CoreException { IProject project = fProjectProvider.getProject(); if (!project.exists()) { CoreUtility.createProject(project, fProjectProvider.getLocationPath(), null); project.open(null); } if (!project.hasNature(MDE.PLUGIN_NATURE)) CoreUtility.addNatureToProject(project, MDE.PLUGIN_NATURE, null); if (!fData.isSimple() && !project.hasNature(JavaCore.NATURE_ID)) CoreUtility.addNatureToProject(project, JavaCore.NATURE_ID, null); if (!fData.isSimple() && fData.getSourceFolderName() != null && fData.getSourceFolderName().trim().length() > 0) { IFolder folder = project.getFolder(fData.getSourceFolderName()); if (!folder.exists()) CoreUtility.createFolder(folder); } return project; } /* * (non-Javadoc) * * @see org.eclipse.ui.actions.WorkspaceModifyOperation#execute(org.eclipse.core.runtime.IProgressMonitor) */ protected void execute(IProgressMonitor monitor) throws CoreException, InvocationTargetException, InterruptedException { // start task monitor.beginTask(MDEUIMessages.NewProjectCreationOperation_creating, getNumberOfWorkUnits()); monitor.subTask(MDEUIMessages.NewProjectCreationOperation_project); // create project IProject project = createProject(); monitor.worked(1); createContents(monitor, project); // set classpath if project has a Java nature if (project.hasNature(JavaCore.NATURE_ID)) { monitor.subTask(MDEUIMessages.NewProjectCreationOperation_setClasspath); setClasspath(project, fData); monitor.worked(1); } if (fData instanceof PluginFieldData) { PluginFieldData data = (PluginFieldData) fData; // generate top-level Java class if that option is selected if (data.doGenerateClass()) { generateTopLevelPluginClass(project, new SubProgressMonitor(monitor, 1)); } // add API Tools nature if requested if (data.doEnableAPITooling()) { addApiAnalysisNature(); } } // generate the manifest file monitor.subTask(MDEUIMessages.NewProjectCreationOperation_manifestFile); createManifest(project); monitor.worked(1); // generate the build.properties file monitor.subTask(MDEUIMessages.NewProjectCreationOperation_buildPropertiesFile); createBuildPropertiesFile(project); monitor.worked(1); // generate content contributed by template wizards boolean contentWizardResult = true; if (fContentWizard != null) { contentWizardResult = fContentWizard.performFinish(project, fModel, new SubProgressMonitor(monitor, 1)); } if (fData instanceof AbstractFieldData) { String framework = ((AbstractFieldData) fData).getOSGiFramework(); if (framework != null) { IEclipsePreferences pref = new ProjectScope(project).getNode(MDECore.PLUGIN_ID); if (pref != null) { pref.putBoolean(ICoreConstants.RESOLVE_WITH_REQUIRE_BUNDLE, false); pref.putBoolean(ICoreConstants.EXTENSIONS_PROPERTY, false); if (!ICoreConstants.EQUINOX.equals(framework)) pref.putBoolean(ICoreConstants.EQUINOX_PROPERTY, false); try { pref.flush(); } catch (BackingStoreException e) { MDEPlugin.logException(e); } } } } if (fData.hasBundleStructure() && fModel instanceof WorkspaceBundlePluginModelBase) { adjustManifests(new SubProgressMonitor(monitor, 1), project, fModel.getMonitorBase()); } fModel.save(); openFile((IFile) fModel.getUnderlyingResource()); monitor.worked(1); fResult = contentWizardResult; } private Set getImportPackagesSet() { TreeSet set = new TreeSet(); if (fGenerator != null) { String[] packages = fGenerator.getImportPackages(); for (int i = 0; i < packages.length; i++) { set.add(packages[i]); } } if (fContentWizard instanceof IBundleContentWizard) { String[] packages = ((IBundleContentWizard) fContentWizard).getImportPackages(); for (int i = 0; i < packages.length; i++) { set.add(packages[i]); } } return set; } protected void fillBinIncludes(IProject project, IBuildEntry binEntry) throws CoreException { if ((!fData.hasBundleStructure() || fContentWizard != null) && ((AbstractFieldData) fData).getOSGiFramework() == null) binEntry.addToken(fData instanceof IFragmentFieldData ? ICoreConstants.FRAGMENT_FILENAME_DESCRIPTOR : ICoreConstants.PLUGIN_FILENAME_DESCRIPTOR); if (fData.hasBundleStructure()) binEntry.addToken("META-INF/"); //$NON-NLS-1$ if (!fData.isSimple()) { String libraryName = fData.getLibraryName(); binEntry.addToken(libraryName == null ? "." : libraryName); //$NON-NLS-1$ } if (fContentWizard != null) { String[] files = fContentWizard.getNewFiles(); for (int j = 0; j < files.length; j++) { if (!binEntry.contains(files[j])) binEntry.addToken(files[j]); } } } private void generateTopLevelPluginClass(IProject project, IProgressMonitor monitor) throws CoreException { PluginFieldData data = (PluginFieldData) fData; fGenerator = new PluginClassCodeGenerator(project, data.getClassname(), data, fContentWizard != null); fGenerator.generate(monitor); monitor.done(); } private IClasspathEntry[] getClassPathEntries(IJavaProject project, IFieldData data) { IClasspathEntry[] internalClassPathEntries = getInternalClassPathEntries(project, data); IClasspathEntry[] entries = new IClasspathEntry[internalClassPathEntries.length + 2]; System.arraycopy(internalClassPathEntries, 0, entries, 2, internalClassPathEntries.length); // Set EE of new project String executionEnvironment = null; if (data instanceof AbstractFieldData) { executionEnvironment = ((AbstractFieldData) data).getExecutionEnvironment(); } ClasspathComputer.setComplianceOptions(project, executionEnvironment); entries[0] = ClasspathComputer.createJREEntry(executionEnvironment); entries[1] = ClasspathComputer.createContainerEntry(); return entries; } private IMonitorReference[] getDependencies() { ArrayList result = new ArrayList(); if (fGenerator != null) { IMonitorReference[] refs = fGenerator.getDependencies(); for (int i = 0; i < refs.length; i++) { result.add(refs[i]); } } if (fContentWizard != null) { IMonitorReference[] refs = fContentWizard.getDependencies(fData.isLegacy() ? null : "3.0"); //$NON-NLS-1$ for (int j = 0; j < refs.length; j++) { if (!result.contains(refs[j])) result.add(refs[j]); } } return (IMonitorReference[]) result.toArray(new IMonitorReference[result.size()]); } protected IClasspathEntry[] getInternalClassPathEntries(IJavaProject project, IFieldData data) { if (data.getSourceFolderName() == null) { return new IClasspathEntry[0]; } IClasspathEntry[] entries = new IClasspathEntry[1]; IPath path = project.getProject().getFullPath().append(data.getSourceFolderName()); entries[0] = JavaCore.newSourceEntry(path); return entries; } protected int getNumberOfWorkUnits() { int numUnits = 4; if (fData.hasBundleStructure()) numUnits++; if (fData instanceof IPluginFieldData) { IPluginFieldData data = (IPluginFieldData) fData; if (data.doGenerateClass()) numUnits++; if (fContentWizard != null) numUnits++; } return numUnits; } public boolean getResult() { return fResult; } /** * Attempts to select the given file in the active workbench part and open the file * in its default editor. Uses asyncExec to join with the UI thread. * * @param file file to open the editor on */ private void openFile(final IFile file) { MDEPlugin.getDefault().getWorkbench().getDisplay().asyncExec(new Runnable() { public void run() { final IWorkbenchWindow ww = MDEPlugin.getActiveWorkbenchWindow(); final IWorkbenchPage page = ww.getActivePage(); if (page == null) return; IWorkbenchPart focusPart = page.getActivePart(); if (focusPart instanceof ISetSelectionTarget) { ISelection selection = new StructuredSelection(file); ((ISetSelectionTarget) focusPart).selectReveal(selection); } try { IDE.openEditor(page, file, true); } catch (PartInitException e) { } } }); } private void setClasspath(IProject project, IFieldData data) throws JavaModelException, CoreException { IJavaProject javaProject = JavaCore.create(project); // Set output folder if (data.getOutputFolderName() != null) { IPath path = project.getFullPath().append(data.getOutputFolderName()); javaProject.setOutputLocation(path, null); } IClasspathEntry[] entries = getClassPathEntries(javaProject, data); javaProject.setRawClasspath(entries, null); } protected void setPluginLibraries(WorkspaceMonitorModelBase model) throws CoreException { String libraryName = fData.getLibraryName(); if (libraryName == null && !fData.hasBundleStructure()) { libraryName = "."; //$NON-NLS-1$ } if (libraryName != null) { IMonitorLibrary library = model.getMonitorFactory().createLibrary(); library.setName(libraryName); library.setExported(!fData.hasBundleStructure()); fModel.getMonitorBase().add(library); } } /** * @param values a {@link Set} containing packages names as {@link String}s * @param version a {@link String} representing the version to set on the package, <code>null</code> allowed. * @return a {@link String} representing the given packages, with the exported version set correctly.<br> * If there's only one package and version is not null, package is exported with that version number. */ protected String getCommaValuesFromPackagesSet(Set values, String version) { StringBuffer buffer = new StringBuffer(); Iterator iter = values.iterator(); while (iter.hasNext()) { if (buffer.length() > 0) { buffer.append(",\n "); //$NON-NLS-1$ // space required for multiline headers } String value = iter.next().toString(); buffer.append(value); if (value.indexOf(";version=") == -1 && (version != null) && (values.size() == 1)) { //$NON-NLS-1$ buffer.append(";version=\"").append(version).append("\""); //$NON-NLS-1$ //$NON-NLS-2$ } } return buffer.toString(); } private void addAllSourcePackages(IProject project, Set list) { try { IJavaProject javaProject = JavaCore.create(project); IClasspathEntry[] classpath = javaProject.getRawClasspath(); for (int i = 0; i < classpath.length; i++) { IClasspathEntry entry = classpath[i]; if (entry.getEntryKind() == IClasspathEntry.CPE_SOURCE) { IPath path = entry.getPath().removeFirstSegments(1); if (path.segmentCount() > 0) { IPackageFragmentRoot root = javaProject.getPackageFragmentRoot(project.getFolder(path)); IJavaElement[] children = root.getChildren(); for (int j = 0; j < children.length; j++) { IPackageFragment frag = (IPackageFragment) children[j]; if (frag.getChildren().length > 0 || frag.getNonJavaResources().length > 0) list.add(children[j].getElementName()); } } } } } catch (JavaModelException e) { } } /** * Add the API analysis nature to the project * @param add */ private void addApiAnalysisNature() { try { IProject project = fProjectProvider.getProject(); IProjectDescription description = project.getDescription(); String[] prevNatures = description.getNatureIds(); String[] newNatures = new String[prevNatures.length + 1]; System.arraycopy(prevNatures, 0, newNatures, 0, prevNatures.length); newNatures[prevNatures.length] = "org.eclipse.pde.api.tools.apiAnalysisNature"; //$NON-NLS-1$ description.setNatureIds(newNatures); project.setDescription(description, new NullProgressMonitor()); } catch (CoreException ce) { //ignore } } }