-/*******************************************************************************\r
- * Copyright (c) 2007, 2008 IBM Corporation and others.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- * IBM Corporation - initial API and implementation\r
- *******************************************************************************/\r
-package org.eclipse.equinox.internal.provisional.p2.installer;\r
-\r
-import org.eclipse.core.runtime.IProgressMonitor;\r
-import org.eclipse.core.runtime.IStatus;\r
-import org.eclipse.core.runtime.OperationCanceledException;\r
-\r
-/**\r
- * The install advisor helps to make decisions during install, and is the conduit\r
- * for reporting progress and results back to an end user or log.\r
- */\r
-public abstract class InstallAdvisor {\r
- /**\r
- * Performs the actual install. The advisor is responsible for handling progress\r
- * monitoring and cancelation. The advisor may perform the install in\r
- * another thread, but must block the calling thread until the install\r
- * completes.\r
- * \r
- * @param operation The install operation to run\r
- * @return IStatus The result of the install operation. This is typically\r
- * just the return value of {@link IInstallOperation#install(IProgressMonitor)},\r
- * but the advisor may alter the result status if desired.\r
- */\r
- public abstract IStatus performInstall(IInstallOperation operation);\r
-\r
- /**\r
- * Allows the advisor to modify or fill in missing values in the install description. \r
- * @param description The initial install description\r
- * @return The install description to be used for the install.\r
- * @exception OperationCanceledException if the install should be canceled.\r
- */\r
- public abstract InstallDescription prepareInstallDescription(InstallDescription description);\r
-\r
- /**\r
- * Prompts for whether the installed application should be launched immediately.\r
- * This method is only called after a successful install.\r
- * \r
- * @param description The initial install description\r
- * @return <code>true</code> if the product should be launched, and \r
- * <code>false</code> otherwise.\r
- */\r
- public abstract boolean promptForLaunch(InstallDescription description);\r
-\r
- /**\r
- * Reports some result information to the context. The status may be\r
- * information, warning, or an error.\r
- */\r
- public abstract void setResult(IStatus status);\r
-\r
- /**\r
- * Initializes the install advisor. This method must be called before calling any \r
- * other methods on the advisor are called. Subsequent invocations of this\r
- * method are ignored.\r
- */\r
- public abstract void start();\r
-\r
- /**\r
- * Stops the install advisor. The advisor becomes invalid after it has been\r
- * stopped; a stopped advisor cannot be restarted.\r
- */\r
- public abstract void stop();\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2008 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
+ *******************************************************************************/
+package org.eclipse.equinox.internal.provisional.p2.installer;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+
+/**
+ * The install advisor helps to make decisions during install, and is the conduit
+ * for reporting progress and results back to an end user or log.
+ */
+public abstract class InstallAdvisor {
+ /**
+ * Performs the actual install. The advisor is responsible for handling progress
+ * monitoring and cancelation. The advisor may perform the install in
+ * another thread, but must block the calling thread until the install
+ * completes.
+ *
+ * @param operation The install operation to run
+ * @return IStatus The result of the install operation. This is typically
+ * just the return value of {@link IInstallOperation#install(IProgressMonitor)},
+ * but the advisor may alter the result status if desired.
+ */
+ public abstract IStatus performInstall(IInstallOperation operation);
+
+ /**
+ * Allows the advisor to modify or fill in missing values in the install description.
+ * @param description The initial install description
+ * @return The install description to be used for the install.
+ * @exception OperationCanceledException if the install should be canceled.
+ */
+ public abstract InstallDescription prepareInstallDescription(InstallDescription description);
+
+ /**
+ * Prompts for whether the installed application should be launched immediately.
+ * This method is only called after a successful install.
+ *
+ * @param description The initial install description
+ * @return <code>true</code> if the product should be launched, and
+ * <code>false</code> otherwise.
+ */
+ public abstract boolean promptForLaunch(InstallDescription description);
+
+ /**
+ * Reports some result information to the context. The status may be
+ * information, warning, or an error.
+ */
+ public abstract void setResult(IStatus status);
+
+ /**
+ * Initializes the install advisor. This method must be called before calling any
+ * other methods on the advisor are called. Subsequent invocations of this
+ * method are ignored.
+ */
+ public abstract void start();
+
+ /**
+ * Stops the install advisor. The advisor becomes invalid after it has been
+ * stopped; a stopped advisor cannot be restarted.
+ */
+ public abstract void stop();
+}
Code Review / simantics / platform.git / blobdiff