|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.update.core.BaseInstallHandler
public class BaseInstallHandler
Base implementation of an install handler. This is a convenience implementation of an install handler with null implementation of its methods. It allows subclasses to selectively implement only the methods required for their installation tasks.
This class should be subclassed by clients.
Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IInstallHandler| Field Summary | |
|---|---|
protected IInstallHandlerEntry |
entry
Model entry that defines this handler |
protected IFeature |
feature
The target of the action |
protected boolean |
initialized
Indicates if handler has been initialized |
protected InstallMonitor |
monitor
Optional progress monitor, can be null |
protected INonPluginEntry[] |
nonPluginEntries
Non-plug-in entries downloaded |
protected IPluginEntry[] |
pluginEntries
Plug-in entries downloaded |
protected int |
type
Update action type |
| Fields inherited from interface org.eclipse.update.core.IInstallHandler |
|---|
HANDLER_ACTION_CONFIGURE, HANDLER_ACTION_INSTALL, HANDLER_ACTION_UNCONFIGURE, HANDLER_ACTION_UNINSTALL |
| Constructor Summary | |
|---|---|
BaseInstallHandler()
|
|
| Method Summary | |
|---|---|
void |
completeConfigure()
Called after the feature has been configured. |
void |
completeInstall(IFeatureContentConsumer consumer)
Called after the feature files and any downloaded plug-ins have been installed. |
void |
completeUnconfigure()
Called after the feature has been unconfigured. |
void |
completeUninstall()
Called after the feature has been uninstalled. |
void |
configureCompleted(boolean success)
Called at the end of the configure action. |
void |
configureInitiated()
Called at the start of the configure action. |
void |
initialize(int type,
IFeature feature,
IInstallHandlerEntry entry,
InstallMonitor monitor)
Initialize the install handler. |
void |
installCompleted(boolean success)
Called at the end of the install action. |
void |
installInitiated()
Called at the start of the install action. |
void |
nonPluginDataDownloaded(INonPluginEntry[] nonPluginData,
IVerificationListener listener)
Called after files corresponding to non-plug-in entries have been downloaded. |
void |
pluginsDownloaded(IPluginEntry[] plugins)
Called after files corresponding to plug-in entries have been downloaded, but before they are actully unpacked and installed. |
void |
unconfigureCompleted(boolean success)
Called at the end of the unconfigure action. |
void |
unconfigureInitiated()
Called at the start of the unconfigure action. |
void |
uninstallCompleted(boolean success)
Called at the end of the uninstall action. |
void |
uninstallInitiated()
Called at the start of the uninstall action. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected int type
IInstallHandler.HANDLER_ACTION_INSTALL,
IInstallHandler.HANDLER_ACTION_CONFIGURE,
IInstallHandler.HANDLER_ACTION_UNCONFIGURE,
IInstallHandler.HANDLER_ACTION_UNINSTALLprotected IFeature feature
protected IInstallHandlerEntry entry
protected InstallMonitor monitor
null
protected IPluginEntry[] pluginEntries
IInstallHandler.HANDLER_ACTION_INSTALLprotected INonPluginEntry[] nonPluginEntries
IInstallHandler.HANDLER_ACTION_INSTALLprotected boolean initialized
| Constructor Detail |
|---|
public BaseInstallHandler()
| Method Detail |
|---|
public void initialize(int type,
IFeature feature,
IInstallHandlerEntry entry,
InstallMonitor monitor)
throws CoreException
initialize in interface IInstallHandlertype - update action typefeature - the target of the actionentry - model entry that defines this handlermonitor - optional progress monitor, can be null
CoreExceptionIInstallHandler.initialize(int, IFeature, IInstallHandlerEntry, InstallMonitor)
public void installInitiated()
throws CoreException
installInitiated in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.installInitiated()
public void pluginsDownloaded(IPluginEntry[] plugins)
throws CoreException
pluginsDownloaded in interface IInstallHandlerplugins - downloaded plug-in entries. Note this may be a subset
of the plug-ins actually references by the feature.
CoreException - terminates the actionIInstallHandler.pluginsDownloaded(IPluginEntry[])
public void nonPluginDataDownloaded(INonPluginEntry[] nonPluginData,
IVerificationListener listener)
throws CoreException
nonPluginDataDownloaded in interface IInstallHandlernonPluginData - downloaded non-plug-in entries.listener - verification listener, may be null.
CoreException - terminates the actionIInstallHandler.nonPluginDataDownloaded(INonPluginEntry[], IVerificationListener)
public void completeInstall(IFeatureContentConsumer consumer)
throws CoreException
completeInstall in interface IInstallHandlerconsumer - content consumer for the feature. The install handler
can choose to use this consumer to install the non-plug-in data,
or can handle the data in any other way. If using the consumer,
the install handler should only call
CoreException - terminates the actionIInstallHandler.completeInstall(IFeatureContentConsumer)
public void installCompleted(boolean success)
throws CoreException
installCompleted in interface IInstallHandlersuccess - indicates action success.
CoreException - terminates the actionIInstallHandler.installCompleted(boolean)
public void configureInitiated()
throws CoreException
configureInitiated in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.configureInitiated()
public void completeConfigure()
throws CoreException
completeConfigure in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.completeConfigure()
public void configureCompleted(boolean success)
throws CoreException
configureCompleted in interface IInstallHandlersuccess - indicates action success.
CoreException - terminates the actionIInstallHandler.configureCompleted(boolean)
public void unconfigureInitiated()
throws CoreException
unconfigureInitiated in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.unconfigureInitiated()
public void completeUnconfigure()
throws CoreException
completeUnconfigure in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.completeUnconfigure()
public void unconfigureCompleted(boolean success)
throws CoreException
unconfigureCompleted in interface IInstallHandlersuccess - indicates action success.
CoreException - terminates the actionIInstallHandler.unconfigureCompleted(boolean)
public void uninstallInitiated()
throws CoreException
uninstallInitiated in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.uninstallInitiated()
public void completeUninstall()
throws CoreException
completeUninstall in interface IInstallHandlerCoreException - terminates the actionIInstallHandler.completeUninstall()
public void uninstallCompleted(boolean success)
throws CoreException
uninstallCompleted in interface IInstallHandlersuccess - indicates action success.
CoreException - terminates the actionIInstallHandler.uninstallCompleted(boolean)
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.